For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
GuidesIntegrationsAPI ReferencesRelease notes
GuidesIntegrationsAPI ReferencesRelease notes
    • APIs overview
  • Upload API
    • Errors
  • REST API
    • Authentication
      • GETList of files
      • PUTStore file
      • DELDelete file
      • GETFile info
      • PUTBatch file storing
      • DELBatch file delete
      • POSTCopy file to local storage
      • POSTCopy file to remote storage
    • File Metadata
    • Add Ons
    • Changelog
    • Versioning
  • URL API
    • File groups
    • Image processing limitations
    • Image compression
    • Image resize and crop
    • Image rotation
    • Image overlays
    • Image colors
    • Image definition
    • Image recognition
    • Other image operations
    • Proxy
    • Signed URLs
    • CDN settings
    • Integrations
Dashboard
LogoLogo
REST APIFile

List of files

GET
https://api.uploadcare.com/files/
GET
/files/
$curl -G https://api.uploadcare.com/files/ \
>     -H "Accept: application/vnd.uploadcare-v0.7+json" \
>     -H "Authorization: <apiKey>" \
>     -d include=appdata
1{
2  "next": "https://api.uploadcare.com/files/?limit=1&from=2018-11-27T01%3A00%3A43.001705%2B00%3A00&offset=0",
3  "previous": "https://api.uploadcare.com/files/?limit=1&to=2018-11-27T01%3A00%3A36.436838%2B00%3A00&offset=0",
4  "total": 2484,
5  "totals": {
6    "removed": 0,
7    "stored": 2480,
8    "unstored": 4
9  },
10  "per_page": 1,
11  "results": [
12    {
13      "datetime_removed": null,
14      "datetime_stored": "2018-11-26T12:49:10.477888Z",
15      "datetime_uploaded": "2018-11-26T12:49:09.945335Z",
16      "is_image": true,
17      "is_ready": true,
18      "mime_type": "image/jpeg",
19      "original_file_url": "https://ucarecdn.com/22240276-2f06-41f8-9411-755c8ce926ed/pineapple.jpg",
20      "original_filename": "pineapple.jpg",
21      "size": 642,
22      "url": "https://api.uploadcare.com/files/22240276-2f06-41f8-9411-755c8ce926ed/",
23      "uuid": "22240276-2f06-41f8-9411-755c8ce926ed",
24      "variations": null,
25      "content_info": {
26        "mime": {
27          "mime": "image/jpeg",
28          "type": "image",
29          "subtype": "jpeg"
30        },
31        "image": {
32          "color_mode": "RGB",
33          "orientation": 6,
34          "format": "JPEG",
35          "sequence": false,
36          "height": 500,
37          "width": 500,
38          "geo_location": {
39            "latitude": 55.62013611111111,
40            "longitude": 37.66299166666666
41          },
42          "datetime_original": "2018-08-20T08:59:50",
43          "dpi": [
44            72,
45            72
46          ]
47        }
48      },
49      "metadata": {
50        "subsystem": "uploader",
51        "pet": "cat"
52      },
53      "appdata": {
54        "uc_clamav_virus_scan": {
55          "version": "0.104.2",
56          "datetime_created": "2021-09-21T11:24:33.159663Z",
57          "datetime_updated": "2021-09-21T11:24:33.159663Z",
58          "data": {
59            "infected": true,
60            "infected_with": "Win.Test.EICAR_HDB-1"
61          }
62        }
63      }
64    }
65  ]
66}

Getting a paginated list of files. If you need multiple results pages, use previous/next from the response to navigate back/forth.

Was this page helpful?
Previous

Store file

Next
Built with

Authentication

Authorizationstring
Every request made to `https://api.uploadcare.com/` MUST be signed. HTTPS SHOULD be used with any authorization scheme. Requests MUST contain the `Authorization` header defining `auth-scheme` and `auth-param`: `Authorization: auth-scheme auth-param`. Every request MUST contain the `Accept` header identifying the REST API version: `Accept: application/vnd.uploadcare-v0.7+json`. There are two available authorization schemes: * For production: `Uploadcare`, a scheme where a `signature`, not your Secret API Key MUST be specified. Signatures SHOULD be generated on backend. * For quick tests: `Uploadcare.Simple`, a simple scheme where your [Secret API Key](https://app.uploadcare.com/projects/-/api-keys/) MUST be specified in every request's `auth-param`.

Headers

AcceptstringRequired
Version header.

Query parameters

removedbooleanOptionalDefaults to false

true to only include removed files in the response, false to include existing files. Defaults to false.

storedbooleanOptional

true to only include files that were stored, false to include temporary ones. The default is unset: both stored and not stored files are returned.

limitintegerOptional1-1000Defaults to 100
A preferred amount of files in a list for a single response. Defaults to 100, while the maximum is 1000.
orderingenumOptionalDefaults to datetime_uploaded

Specifies the way files are sorted in a returned list. datetime_uploaded for ascending order, -datetime_uploaded for descending order.

Allowed values:
fromstringOptional

A starting point for filtering the files. If provided, the value MUST adhere to the ISO 8601 Extended Date/Time Format (YYYY-MM-DDTHH:MM:SSZ).

includestringOptional

Include additional fields to the file object, such as: appdata.

Response

A list of files, paginated.
nextstring or nullformat: "uri"
Next page URL.
previousstring or nullformat: "uri"
Previous page URL.
totalinteger>=0
Total number of the files of the queried type. The queried type depends on the stored and removed query parameters.
totalsobject
per_pageinteger
Number of the files per page.
resultslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
406
Not Acceptable Error
429
Too Many Requests Error

Every request made to https://api.uploadcare.com/ MUST be signed. HTTPS SHOULD be used with any authorization scheme.

Requests MUST contain the Authorization header defining auth-scheme and auth-param: Authorization: auth-scheme auth-param.

Every request MUST contain the Accept header identifying the REST API version: Accept: application/vnd.uploadcare-v0.7+json.

There are two available authorization schemes:

  • For production: Uploadcare, a scheme where a signature, not your Secret API Key MUST be specified. Signatures SHOULD be generated on backend.
  • For quick tests: Uploadcare.Simple, a simple scheme where your Secret API Key MUST be specified in every request’s auth-param.