Uploadcare REST API

https://uploadcare.com/api-refs/
Admin
Uploadcare's REST API provides low-level access to its features, enabling management of files,...
Tokens:139,863
Snippets:498
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example JSON Payload for Multipart Upload Start

Source: https://uploadcare.com/api-refs/upload-api

An example JSON payload demonstrating the required and optional parameters for initiating a multipart upload request to the Uploadcare API.

```JSON
{
  "UPLOADCARE_PUB_KEY": "YOUR_PUBLIC_KEY",
  "UPLOADCARE_STORE": "auto",
  "filename": "myfile.mp4",
  "size": 27796904,
  "content_type": "video/mp4",
  "metadata[subsystem]": "uploader",
  "metadata[pet]": "cat"
}
```

--------------------------------

### Example Response for Get File Information

Source: https://uploadcare.com/api-refs/upload-api

This detailed JSON snippet shows a comprehensive example of the data returned by the 'Get Information About an Uploaded File' API, including file metadata, image information, and content details.

```JSON
{
  "uuid": "be3b4d5e-179d-460e-8a5d-69112ac86cbb",
  "file_id": "be3b4d5e-179d-460e-8a5d-69112ac86cbb",
  "size": 2667636,
  "total": 2667636,
  "done": 2667636,
  "original_filename": "IMG-0412_123.JPG",
  "filename": "IMG0412_123.JPG",
  "mime_type": "image/jpeg",
  "image_info": {
    "color_mode": "RGB",
    "orientation": 6,
    "format": "JPEG",
    "height": 4032,
    "width": 3024,
    "sequence": false,
    "geo_location": {
      "latitude": 55.62013611111111,
      "longitude": 37.66299166666666
    },
    "datetime_original": "2018-08-20T08:59:50",
    "dpi": [
      72,
      72
    ]
  },
  "video_info": null,
  "content_info": {
    "mime": {
      "mime": "image/jpeg",
      "type": "image",
      "subtype": "jpeg"
    },
    "image": {
      "color_mode": "RGB",
      "orientation": 6,
      "format": "JPEG",
      "height": 4032,
      "width": 3024,
      "sequence": false,
      "geo_location": {
        "latitude": 55.62013611111111,
        "longitude": 37.66299166666666
      },
      "datetime_original": "2018-08-20T08:59:50",
      "dpi": [
        72,
        72
      ]
    }
  },
  "metadata": {
    "subsystem": "uploader",
    "pet": "cat"
  },
  "is_image": true,
  "is_stored": true,
  "is_ready": true
}
```

--------------------------------

### Multipart Upload Start Successful Response Sample

Source: https://uploadcare.com/api-refs/upload-api

An example JSON response returned upon successful initiation of a multipart upload, including the file UUID and a list of presigned URLs for uploading file parts.

```APIDOC
{
  "uuid": "67947755-1584-4e3f-902b-d4e2bf76a841",
  "parts": [
    "<presigned-url-1>",
    "<presigned-url-2>",
    "<presigned-url-3>",
    "<presigned-url-4>",
    "<presigned-url-5>"
  ]
}
```

--------------------------------

### Example 200 OK Response for URL Upload

Source: https://uploadcare.com/api-refs/upload-api

An example JSON response for a successful file upload from URL, showing a token or file information.

```JSON
{
  "type": "token",
  "token": "945ebb27-1fd6-46c6-a859-b9893712d650"
}
```

--------------------------------

### Example Uploadcare Authentication Headers

Source: https://uploadcare.com/api-refs/rest-api

Illustrative example of HTTP headers required for the 'Uploadcare' authentication scheme, including 'Accept', 'Date', and 'Authorization' with a sample signature.

```HTTP
Accept: application/vnd.uploadcare-v0.7+json
Date: Fri, 30 Sep 2016 11:10:54 GMT
Authorization: Uploadcare public_key:6ff75027649aadd4dc98c1f784444445d1e6ed82
```

--------------------------------

### JavaScript Example: Get File Information using Uploadcare REST Client

Source: https://uploadcare.com/api-refs/rest-api/v0.7

Demonstrates how to fetch file information using the `@uploadcare/rest-client` library in JavaScript. It shows initialization with public and secret keys and calling the `fileInfo` function with a file UUID.

```js
import {
  fileInfo,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await fileInfo(
  {
    uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',
  },
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### JavaScript: List File Groups

Source: https://uploadcare.com/api-refs/rest-api/v0.7

Provides a JavaScript example using `@uploadcare/rest-client` to fetch a paginated list of file groups. It demonstrates the necessary imports, authentication setup, and calling the `listOfGroups` function.

```JS
import {
  listOfGroups,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await listOfGroups({}, { authSchema: uploadcareSimpleAuthSchema })
```

--------------------------------

### Example Document Conversion Response (Success)

Source: https://uploadcare.com/api-refs/rest-api/v0.7

An example JSON response showing the structure for a successful document conversion, including format details and converted group UUIDs.

```APIDOC
{
  "error": null,
  "format": {
    "name": "txt",
    "conversion_formats": [
      {
        "name": "epub"}
,
      {
        "name": "pdf"}
]
  },
  "converted_groups": {
    "pdf": "49732da8-1530-470c-8743-998c4c634718~5"}
}
```

--------------------------------

### Convert Video API Success Response Example

Source: https://uploadcare.com/api-refs/rest-api/v0

An example JSON response for a successful video conversion request, detailing any problems, original sources, tokens, and UUIDs of the processed files.

```APIDOC
{
  "problems": {
    "13cd56e2-f6d7-4c66-ab1b-ffd13cd6646d": "Bad path \"13cd56e2-f6d7-4c66-ab1b-ffd13cd6646d\". Use UUID or CDN URL"
  },
  "result": [
    {
      "original_source": "d52d7136-a2e5-4338-9f45-affbf83b857d/video/-/format/ogg/-/quality/best/",
      "token": 445630631,
      "thumbnails_group_uuid": "575ed4e8-f4e8-4c14-a58b-1527b6d9ee46~1",
      "uuid": "d52d7136-a2e5-4338-9f45-affbf83b857d"
    },
    {
      "original_source": "500196bc-9da5-4aaf-8f3e-70a4ce86edae/video/",
      "token": 445630637,
      "thumbnails_group_uuid": "be3b4d5e-179d-460e-8a5d-69112ac86cbb~1",
      "uuid": "28843a09-dd3d-4b8a-ad4f-8aa5f8f60ff2"
    }
  ]
}
```

--------------------------------

### Example Successful Response for Direct Upload

Source: https://uploadcare.com/api-refs/upload-api

Provides an example of a successful JSON response after a direct file upload, showing the mapping of the uploaded file's original name to its unique Uploadcare UUID.

```JSON
{
  "my_file.jpg": "17be4678-dab7-4bc7-8753-28914a22960a"
}
```

--------------------------------

### Example: Get Video Conversion Job Status (JavaScript)

Source: https://uploadcare.com/api-refs/rest-api/v0.7

This JavaScript code snippet demonstrates how to use the `@uploadcare/rest-client` library to fetch the status of a video conversion job. It shows how to initialize the authentication schema and call the `conversionJobStatus` function with the job token and conversion type.

```JavaScript
import {
  conversionJobStatus,
  ConversionType,
  UploadcareSimpleAuthSchema
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY'
});

const result = await conversionJobStatus(
  {
    type: ConversionType.VIDEO,
    token: 1201016744
  },
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### Example Document Conversion Response (Problems and Results)

Source: https://uploadcare.com/api-refs/rest-api/v0.7

An example JSON response for document conversion, illustrating how the API returns both problematic conversions and successful results with UUIDs and tokens.

```APIDOC
{
  "problems": {
    "8ddbbb48-0927-4df7-afac-c6031668b01b": "Bad path \"8ddbbb48-0927-4df7-afac-c6031668b01b\". Use UUID or CDN URL"}
,
  "result": [
    {
      "original_source": "<https://cdn.uploadcare.com/5ffa2545-ea40-4e71-a9e4-3a8e49b7b737/document/-/format/jpg/-/page/1/>",
      "token": 445630631,
      "uuid": "d52d7136-a2e5-4338-9f45-affbf83b857d"}
,
    {
      "original_source": "88a51210-bd69-4411-bc72-a9952d9512cd/document/-/format/pdf/",
      "token": 445630637,
      "uuid": "28843a09-dd3d-4b8a-ad4f-8aa5f8f60ff2"}

```

--------------------------------

### Example Request Payload for URL Upload

Source: https://uploadcare.com/api-refs/upload-api

An example JSON payload demonstrating how to structure the request body for uploading a file from a URL, including public key, source URL, and custom metadata.

```JSON
{
  "pub_key": "YOUR_PUBLIC_KEY",
  "source_url": "https://source.unsplash.com/featured",
  "metadata[subsystem]": "uploader",
  "metadata[pet]": "cat"
}
```

--------------------------------

### Convert Video API Request Body Payload Example

Source: https://uploadcare.com/api-refs/rest-api/v0

An example JSON payload demonstrating how to specify video UUIDs and storage preferences for the Uploadcare video conversion API.

```APIDOC
{
  "paths": [
    "d52d7136-a2e5-4338-9f45-affbf83b857d/video/",
    "d52d7136-a2e5-4338-9f45-affbf83b857d/video/-/format/ogg/-/quality/best/",
    "28843a09-dd3d-4b8a-ad4f-8aa5f8f60ff2"
  ],
  "store": "1"
}
```

--------------------------------

### Uploadcare.Simple Authentication Header Example

Source: https://uploadcare.com/api-refs/rest-api

This example illustrates the HTTP headers required for the `Uploadcare.Simple` authentication method. It includes the 'Accept' header for API versioning and the 'Authorization' header containing the public and secret key pair.

```HTTP
Accept: application/vnd.uploadcare-v0.7+json
Authorization: Uploadcare.Simple public_key:secret_key
```

--------------------------------

### Example Document Conversion Request Payload

Source: https://uploadcare.com/api-refs/rest-api/v0.7

An example JSON payload for the document conversion API, demonstrating how to specify source document paths, storage options, and group saving.

```APIDOC
{
  "paths": [
    "<https://cdn.uploadcare.com/5ffa2545-ea40-4e71-a9e4-3a8e49b7b737/document/-/format/jpg/-/page/1/>",
    "88a51210-bd69-4411-bc72-a9952d9512cd/document/-/format/pdf/",
    "8ddbbb48-0927-4df7-afac-c6031668b01b/document/"
  ],
  "store": 1,
  "save_in_group": "1"
}
```

--------------------------------

### Example JSON Response for File List

Source: https://uploadcare.com/api-refs/rest-api/v0.5

An example JSON response demonstrating the structure of a file list, including pagination links, total count, and detailed file information such as UUID, URLs, and image metadata. This response is typical for listing files via the Uploadcare API.

```json
{
  "next": "[https://api.uploadcare.com/files/?limit=3&from=2018-11-27T01%3A00%3A43.001705%2B00%3A00&offset=0](https://api.uploadcare.com/files/?limit=3&from=2018-11-27T01%253A00%253A43.001705%252B00%253A00&offset=0)",
  "previous": "[https://api.uploadcare.com/files/?limit=3&to=2018-11-27T01%3A00%3A36.436838%2B00%3A00&offset=0](https://api.uploadcare.com/files/?limit=3&to=2018-11-27T01%253A00%253A36.436838%252B00%253A00&offset=0)",
  "total": 2484,
  "per_page": 2,
  "results": [
    {
      "datetime_removed": null,
      "datetime_stored": "2018-11-26T12:49:10.477888Z",
      "datetime_uploaded": "2018-11-26T12:49:09.945335Z",
      "image_info": {
        "color_mode": "RGB",
        "orientation": null,
        "format": "JPEG",
        "sequence": false,
        "height": 500,
        "width": 500,
        "geo_location": null,
        "datetime_original": null,
        "dpi": [
          144,
          144
        ]
      },
      "is_image": true,
      "is_ready": true,
      "mime_type": "application/octet-stream",
      "original_file_url": "<https://ucarecdn.com/22240276-2f06-41f8-9411-755c8ce926ed/pineapple.jpg>",
      "original_filename": "pineapple.jpg",
      "size": 642,
      "url": "<https://api.uploadcare.com/files/22240276-2f06-41f8-9411-755c8ce926ed/>",
      "uuid": "22240276-2f06-41f8-9411-755c8ce926ed"
    },
    {
      "datetime_removed": null,
      "datetime_stored": "2018-11-26T12:49:10.477888Z",
      "datetime_uploaded": "2018-11-26T12:49:09.945335Z",
      "image_info": {
        "color_mode": "RGB",
        "orientation": null,
        "format": "JPEG",
        "sequence": false,
        "height": 500,
        "width": 500,
        "geo_location": null,
        "datetime_original": null,
        "dpi": [
          144,
          144
        ]
      },
      "is_image": true,
      "is_ready": true,
      "mime_type": "application/octet-stream",
      "original_file_url": "<https://ucarecdn.com/22240276-2f06-41f8-9411-755c8ce926ed/pineapple.jpg>",
      "original_filename": "pineapple.jpg",
      "size": 642,
      "url": "<https://api.uploadcare.com/files/22240276-2f06-41f8-9411-755c8ce926ed/>",
      "uuid": "22240276-2f06-41f8-9411-755c8ce926ed"
    }
  ]
}
```

--------------------------------

### API Endpoint: Get Information About a File Group

Source: https://uploadcare.com/api-refs/upload-api

This section documents the API endpoint for retrieving details about a specific file group. It outlines the HTTP method (GET), the endpoint path, and the required query parameters (`pub_key` and `group_id`) along with their types and examples. It also lists possible HTTP response codes (200, 400, 403, 404) and their meanings.

```APIDOC
Endpoint: GET /group/info/
Production Server: https://upload.uploadcare.com/group/info/

Description: Returns a JSON object with information about a file group (when the group was created, number of the files in the group, etc).

Query Parameters:
- pub_key (string, required): Public key identifying an Uploadcare project. Example: pub_key=YOUR_PUBLIC_KEY
- group_id (string, required): Group's unique ID. Looks like UUID~N. Example: group_id=d52d7136-a2e5-4338-9f45-affbf83b857d~2

Responses:
- 200: File group information retrieved successfully.
- 400: Request failed input parameters validation.
- 403: Request was not allowed.
- 404: Group with specified UUID was not found.
```

--------------------------------

### Get All File Metadata (JavaScript)

Source: https://uploadcare.com/api-refs/rest-api

Example JavaScript code demonstrating how to retrieve all metadata associated with a specific file UUID using the Uploadcare REST client. It requires 'publicKey' and 'secretKey' for authentication.

```JS
import {
  getMetadata,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await getMetadata(
  {
    uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',
  },
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### Project API 200 OK Response Sample

Source: https://uploadcare.com/api-refs/rest-api/v0.5

Example JSON response for a successful (200 OK) API call to retrieve project details, including collaborators, project name, public key, and autostore status.

```json
{
  "collaborators": [ ],
  "name": "demo",
  "pub_key": "YOUR_PUBLIC_KEY",
  "autostore_enabled": true
}
```

--------------------------------

### Get Video Conversion Job Status using JavaScript SDK

Source: https://uploadcare.com/api-refs/rest-api/v0

Example JavaScript code snippet demonstrating how to use the `@uploadcare/rest-client` library to fetch the status of a video conversion job by its unique token.

```JavaScript
import {
  conversionJobStatus,
  ConversionType,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await conversionJobStatus(
  {
    type: ConversionType.VIDEO,
    token: 1201016744
  },
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### Create Webhook in JavaScript

Source: https://uploadcare.com/api-refs/rest-api

Example demonstrating how to create a webhook using the `@uploadcare/rest-client` library in JavaScript. It shows how to initialize the authentication schema and call the `createWebhook` function with required parameters.

```JS
import {
  createWebhook,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await createWebhook(
  {
    targetUrl: 'https://yourwebhook.com',
    event: 'file.uploaded',
    isActive: true,
  },
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### Get all file metadata

Source: https://uploadcare.com/api-refs/rest-api/v0.7

This section details the API endpoint and provides a JavaScript example for retrieving all metadata associated with a specific file UUID. It covers request parameters, possible responses, and a sample JSON response.

```APIDOC
API Endpoint: GET /files/{uuid}/metadata/
Production Server: https://api.uploadcare.com/files/{uuid}/metadata/

Header Parameters:
  Accept:
    Type: string or null
    Example: application/vnd.uploadcare-v0.7+json
    Description: Version header.

Responses:
  200: File metadata in JSON.
  400: Simple authentication over HTTP is forbidden. Please, use HTTPS or signed requests instead.
  401: Authorization errors.
  406: Invalid version header `Accept` for this endpoint.

Response Sample (application/json):
{
  "subsystem": "uploader",
  "pet": "cat"
}
```

```JS
import {
  getMetadata,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await getMetadata(
  {
    uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',
  },
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### List Uploadcare Files with JavaScript SDK

Source: https://uploadcare.com/api-refs/rest-api/v0.7

This JavaScript example demonstrates how to use the `@uploadcare/rest-client` library to fetch a list of files. It shows the initialization of `UploadcareSimpleAuthSchema` with public and secret keys, and then calling the `listOfFiles` function.

```JavaScript
import {
  listOfFiles,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await listOfFiles(
  {},
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### APIDOC: Example Paginated Response for List File Groups

Source: https://uploadcare.com/api-refs/rest-api

Shows a sample JSON response for a successful `GET /groups/` request, illustrating the paginated structure with `next`, `previous`, `total`, `per_page`, and `results` containing group objects.

```APIDOC
{
  "next": "[https://api.uploadcare.com/groups/?limit=3&from=2016-11-09T14%3A30%3A22.421889%2B00%3A00&offset=0](https://api.uploadcare.com/groups/?limit=3&from=2016-11-09T14%253A30%253A22.421889%252B00%253A00&offset=0)",
  "previous": null,
  "total": 100,
  "per_page": 2,
  "results": [
    {
      "id": "dd43982b-5447-44b2-86f6-1c3b52afa0ff~1",
      "datetime_created": "2018-11-27T14:14:37.583654Z",
      "files_count": 1,
      "cdn_url": "<https://ucarecdn.com/dd43982b-5447-44b2-86f6-1c3b52afa0ff~1/>",
      "url": "<https://api.uploadcare.com/groups/dd43982b-5447-44b2-86f6-1c3b52afa0ff~1/>"
    },
    {
      "id": "fd59dbcb-40a1-4f3a-8062-cc7d23f66885~1",
      "datetime_created": "2018-11-27T15:14:39.586674Z",
      "files_count": 1,
      "cdn_url": "<https://ucarecdn.com/fd59dbcb-40a1-4f3a-8062-cc7d23f66885~1/>",
      "url": "<https://api.uploadcare.com/groups/fd59dbcb-40a1-4f3a-8062-cc7d23f66885~1/>"
    }
  ]
}
```

--------------------------------

### Example Headers for Uploadcare Authentication

Source: https://uploadcare.com/api-refs/rest-api/v0.7

Illustrates the required HTTP headers for a request using the Uploadcare authentication scheme, including Accept, Date, and Authorization with a sample signature.

```HTTP
Accept: application/vnd.uploadcare-v0.7+json
Date: Fri, 30 Sep 2016 11:10:54 GMT
Authorization: Uploadcare public_key:6ff75027649aadd4dc98c1f784444445d1e6ed82
```

--------------------------------

### Create Webhook (JavaScript)

Source: https://uploadcare.com/api-refs/rest-api/v0.7

Example JavaScript code demonstrating how to create a new webhook using the `@uploadcare/rest-client` library. It shows how to initialize authentication with a public and secret key, and then call the `createWebhook` function with necessary parameters like `targetUrl` and `event`.

```JavaScript
import {
  createWebhook,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await createWebhook(
  {
    targetUrl: 'https://yourwebhook.com',
    event: 'file.uploaded',
    isActive: true,
  },
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### API Reference: Get Remove Background Status

Source: https://uploadcare.com/api-refs/rest-api/v0.7

Documents the API endpoint for checking the status of a background removal operation. It includes the endpoint URL, possible HTTP response codes with their meanings, and an example JSON response structure.

```APIDOC
Endpoint: GET https://api.uploadcare.com/addons/remove_bg/execute/status/
Responses:
  200: Add-On execution response. See file_id in response in order to get image without background.
  400: Simple authentication over HTTP is forbidden. Please, use HTTPS or signed requests instead.
  401: Authorization errors.
  406: Invalid version header Accept for this endpoint.
```

```JSON
{
  "result": {
    "file_id": "21975c81-7f57-4c7a-aef9-acfe28779f78"
  },
  "status": "done"
}
```

--------------------------------

### PHP: Retrieve Project Information

Source: https://uploadcare.com/api-refs/rest-api

Shows how to fetch project details using the Uploadcare PHP SDK. It initializes the API, retrieves project info, and then prints the project name, public key, auto-store status, and iterates through collaborators.

```PHP
<?php
$configuration = Uploadcare\Configuration::create((string) $_ENV['UPLOADCARE_PUBLIC_KEY'], (string) $_ENV['UPLOADCARE_SECRET_KEY']);

$api = (new Uploadcare\Api($configuration))->project();
$projectInfo = $api->getProjectInfo();
echo \sprintf("Project %s info:\n", $projectInfo->getName());
echo \sprintf("Public key: %s\n", $projectInfo->getPubKey());
echo \sprintf("Auto-store enabled: %s\n", $projectInfo->isAutostoreEnabled() ? 'yes' : 'no');
foreach ($projectInfo->getCollaborators() as $email => $name) {
    echo \sprintf("%s: %s\n", $name, $email);
}
```

--------------------------------

### Get Single File Metadata Key Value (JavaScript)

Source: https://uploadcare.com/api-refs/rest-api

Example JavaScript code to retrieve the value of a specific metadata key for a given file UUID using the Uploadcare REST client. Authentication is handled via 'publicKey' and 'secretKey'.

```JS
import {
  getMetadataValue,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await getMetadataValue(
  {
    uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',
    key: 'pet'
  },
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### Example HTTP Headers for Uploadcare Authentication

Source: https://uploadcare.com/api-refs/rest-api/v0.6

Illustrates the required `Accept`, `Date`, and `Authorization` HTTP headers for a request using the `Uploadcare` authentication scheme, showing the format for `public_key:signature`.

```APIDOC
Accept: application/vnd.uploadcare-v0.6+json
Date: Fri, 30 Sep 2016 11:10:54 GMT
Authorization: Uploadcare public_key:6ff75027649aadd4dc98c1f784444445d1e6ed82
```

--------------------------------

### Multipart Upload Start Request Body Schema

Source: https://uploadcare.com/api-refs/upload-api

This schema defines the parameters required to initiate a multipart file upload to Uploadcare. It includes fields for public key, storage behavior, filename, size, content type, part size, and optional metadata and security signatures.

```APIDOC
UPLOADCARE_PUB_KEY required: string (projectPublicKeyType)
  Description: Public key identifying an Uploadcare project your uploads will go to.
UPLOADCARE_STORE: string (storeType)
  Default: "auto"
  Enum: "0", "1", "auto"
  Description: Determines if an uploaded file should be marked as temporary or permanent.
    - 0: do not mark an uploaded file as stored and remove it after 24 hours
    - 1: mark the uploaded file as stored
    - auto: delegate the choice of the file-storing behavior to a project-wide setting called auto-store.
filename required: string
  Description: Original file name of the uploaded file.
size required: integer
  Description: Precise file size of the uploaded file (in bytes). Note: The size should not exceed max file size cap for your project.
part_size: integer
  Range: [ 5242880 .. 5368709120 ]
  Default: 5242880
  Description: Multipart Uploads expect that you will split the uploaded file into equally sized parts (except for the last part).
content_type required: string
  Description: File's MIME-type.
metadata[{key}]: string (metadataValue)
  Length: [ 1 .. 512 ] characters
  Description: Arbitrary metadata associated with the file.
signature: string (signatureType)
  Description: Must be sent along with your upload request if you would like to use signed uploads. The signature should be generated on your backend.
expire: number (expireType)
  Description: Must be sent along with your upload request if you would like to use signed uploads. Defines the time during which your signature is valid. It's a UNIX timestamp.
```

--------------------------------

### Example Response Payload for Video Conversion Job Status

Source: https://uploadcare.com/api-refs/rest-api

Provides a sample JSON response for the `GET /convert/video/status/{token}/` endpoint. It shows the job's `status` (e.g., 'processing'), any `error` details, and `result` containing UUIDs related to the conversion.

```JSON
{
  "status": "processing",
  "error": null,
  "result": {
    "thumbnails_group_uuid": "575ed4e8-f4e8-4c14-a58b-1527b6d9ee46~1",
    "uuid": "500196bc-9da5-4aaf-8f3e-70a4ce86edae"
  }
}
```

--------------------------------

### Example Request Payload for Direct Upload

Source: https://uploadcare.com/api-refs/upload-api

Illustrates a sample JSON payload for a direct file upload request using `multipart/form-data`, demonstrating how to include the public key, storage preference, file reference, and custom metadata.

```JSON
{
  "UPLOADCARE_PUB_KEY": "YOUR_PUBLIC_KEY",
  "UPLOADCARE_STORE": "auto",
  "my_file.jpg": "@my_file.jpg",
  "metadata[subsystem]": "uploader",
  "metadata[pet]": "cat"
}
```

--------------------------------

### API Reference: Get Project Information

Source: https://uploadcare.com/api-refs/rest-api/v0.7

Documents the API endpoint for retrieving details about an Uploadcare account project. It specifies the endpoint URL, required authorization, header parameters, possible HTTP response codes, and an example JSON response structure.

```APIDOC
Endpoint: GET https://api.uploadcare.com/project/
Description: Getting info about account project.
Authorizations: apiKeyAuth
Header Parameters:
  Accept:
    Type: string or null
    Required: true
    Example: application/vnd.uploadcare-v0.7+json
    Description: Version header.
Responses:
  200: Your project details.
  400: Simple authentication over HTTP is forbidden. Please, use HTTPS or signed requests instead.
  401: Authorization errors.
  406: Invalid version header Accept for this endpoint.
  429: Request was throttled.
```

```JSON
{
  "collaborators": [],
  "name": "demo",
  "pub_key": "YOUR_PUBLIC_KEY",
  "autostore_enabled": true
}
```

--------------------------------

### Python Example: Generate Uploadcare Signature

Source: https://uploadcare.com/api-refs/rest-api/v0.5

This Python example demonstrates the process of generating the `signature` for Uploadcare's `Uploadcare` authentication method. It shows how to import necessary modules, define the secret key, determine the HTTP verb, calculate the MD5 hash for the request body (empty for GET), set the content type, format the current time into an RFC2822 GMT date header, and construct the URI. Finally, it illustrates how to concatenate these components into a string for HMAC/SHA1 signing.

```Python
import time
import hashlib
import hmac
from email import utils

# Specifying the project’s key
SECRET_KEY = 'YOUR_SECRET_KEY'

# Specifying request type
verb = 'GET'

# Calculate [md5](https://en.wikipedia.org/wiki/MD5) checksum for the request's HTTP body.
# Note: Taking into account that in our example, we are sending an HTTP GET request,
# and the request does not have anything in its HTTP body, we use an empty string as an input to the md5 hash function.
# If we were to send an HTTP POST request with, for example, JSON in the request's body,
# we would have to pass the JSON as the input to the md5 hash function.
content_md5 = hashlib.md5(b'').hexdigest()

# Content-Type header
content_type = 'application/json'

# Current time, e.g. 1541423681
timestamp = int(time.time())
# Date header ('Mon, 05 Nov 2018 13:14:41 GMT')
date_header = utils.formatdate(timestamp, usegmt=True)

# The request URI
uri = '/files/?limit=1&stored=true'

# Forming the final string: concatenating
sign_string = '\n'.join([verb, content_md5, content_type, date_header, uri])

# Calculating the signature,
```

--------------------------------

### Video Conversion API: Request Body Sample

Source: https://uploadcare.com/api-refs/rest-api/v0.5

This JSON snippet demonstrates a sample request body for the video conversion API. It shows how to specify multiple video paths for conversion, including transformation operations, and how to set the `store` parameter for permanent storage.

```json
{
  "paths": [
    "d52d7136-a2e5-4338-9f45-affbf83b857d/video/",
    "d52d7136-a2e5-4338-9f45-affbf83b857d/video/-/format/ogg/-/quality/best/",
    "28843a09-dd3d-4411-bc72-a9952d9512cd"
  ],
  "store": 1
}
```

--------------------------------

### Get a specific file metadata key's value

Source: https://uploadcare.com/api-refs/rest-api/v0.7

This section outlines the API endpoint and provides a JavaScript example for retrieving the value of a single metadata key for a given file UUID. It details path and header parameters, authorization, and possible responses.

```APIDOC
API Endpoint: GET /files/{uuid}/metadata/{key}/
Production Server: https://api.uploadcare.com/files/{uuid}/metadata/{key}/
Authorizations: apiKeyAuth

Path Parameters:
  uuid:
    Type: string <uuid>
    Required: true
    Example: 21975c81-7f57-4c7a-aef9-acfe28779f78
    Description: File UUID.
  key:
    Type: string
    Required: true
    Constraints: [1 .. 64] characters [\\w\\-\\.\\:]+
    Example: subsystem
    Description: Key of file metadata. Allowed characters: Latin letters (a-z,A-Z), digits (0-9), underscore (_), hyphen (-), dot (.), colon (:).

Header Parameters:
  Accept:
    Type: string or null
    Example: application/vnd.uploadcare-v0.7+json
    Description: Version header.

Responses:
  200: Value of a file's metadata key.
  400: Simple authentication over HTTP is forbidden. Please, use HTTPS or signed requests instead.
  401: Authorization errors.
  406: Invalid version header `Accept` for this endpoint.

Response Sample (application/json):
"uploader"
```

```JS
import {
  getMetadataValue,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await getMetadataValue(
  {
    uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',
    key: 'pet'
  },
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### Delete File using Uploadcare REST Client (JavaScript)

Source: https://uploadcare.com/api-refs/rest-api

Example demonstrating how to programmatically delete a file using the `@uploadcare/rest-client` library in JavaScript. It shows the setup of `UploadcareSimpleAuthSchema` with public and secret keys, and then calls the `deleteFile` function with the target file's UUID.

```JavaScript
import {
  deleteFile,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await deleteFile(
  {
    uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',
  },
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### Get Document Conversion Job Status (JavaScript)

Source: https://uploadcare.com/api-refs/rest-api

JavaScript example demonstrating how to retrieve the status of a document conversion job using the `@uploadcare/rest-client` library. It shows how to initialize the client with public and secret keys and call the `conversionJobStatus` function with the job token and conversion type.

```JS
import {
  conversionJobStatus,
  ConversionType,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await conversionJobStatus(
  {
    type: ConversionType.DOCUMENT,
    token: 32921143
  },
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### JavaScript Example: Get File Info using Uploadcare REST Client

Source: https://uploadcare.com/api-refs/rest-api

This JavaScript code snippet demonstrates how to retrieve file information using the `@uploadcare/rest-client` library. It initializes `UploadcareSimpleAuthSchema` with public and secret keys and then calls the `fileInfo` function with a specific file UUID.

```JS
import {
  fileInfo,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await fileInfo(
  {
    uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',
  },
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### List Files using Uploadcare REST Client in JavaScript

Source: https://uploadcare.com/api-refs/rest-api

This JavaScript snippet demonstrates how to use the `@uploadcare/rest-client` library to fetch a list of files. It initializes the `UploadcareSimpleAuthSchema` with public and secret keys and then calls the `listOfFiles` function.

```JavaScript
import {
  listOfFiles,
  UploadcareSimpleAuthSchema,
} from '@uploadcare/rest-client';

const uploadcareSimpleAuthSchema = new UploadcareSimpleAuthSchema({
  publicKey: 'YOUR_PUBLIC_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

const result = await listOfFiles(
  {},
  { authSchema: uploadcareSimpleAuthSchema }
)
```

--------------------------------

### Multipart Upload Start Endpoint URL

Source: https://uploadcare.com/api-refs/upload-api

This is the production server URL for initiating a multipart file upload with Uploadcare.

```APIDOC
https://upload.uploadcare.com/multipart/start/
```

--------------------------------

### Example Response for File Status Check

Source: https://uploadcare.com/api-refs/upload-api

This JSON snippet illustrates a typical response from the `fromUrlStatus` API call, indicating the current status of the file upload.

```JSON
{
  "status": "waiting"
}
```

--------------------------------

### Project API Endpoint Documentation

Source: https://uploadcare.com/api-refs/rest-api/v0.5

API documentation for retrieving information about the account project. It details authorization, required header parameters, and various HTTP response codes.

```APIDOC
Endpoint: GET /project/
Description: Getting info about account project.
Authorizations: apiKeyAuth
Header Parameters:
  Accept:
    Type: string
    Required: true
    Example: application/vnd.uploadcare-v0.5+json
    Description: Version header.
Responses:
  200: Your project details.
  401: Authorization errors.
  406: Invalid version header `Accept` for this endpoint.
  429: Request was throttled.
Production Server: https://api.uploadcare.com/project/
```

--------------------------------

### Batch File Delete Request Payload Example

Source: https://uploadcare.com/api-refs/rest-api/v0.6

Example JSON payload for a batch file deletion request, containing an array of file UUIDs to be deleted. The content type is application/json.

```json
[
  "21975c81-7f57-4c7a-aef9-acfe28779f78",
  "cbaf2d73-5169-4b2b-a543-496cf2813dff"
]
```

--------------------------------

### Curl Command to Upload Individual File Part

Source: https://uploadcare.com/api-refs/upload-api

An example `curl` command demonstrating how to upload a single file part to a presigned URL obtained from the `/multipart/start/` endpoint. It highlights the necessity of setting the `Content-Type` header.

```bash
curl -X PUT "<presigned-url-x>" -H "Content-Type: application/octet-stream" --data <data-part>
```

--------------------------------

### Example: Video Conversion Success Response

Source: https://uploadcare.com/api-refs/rest-api/v0.7

This JSON object illustrates a successful response from the video conversion API. It includes a `problems` object for any issues encountered and a `result` array detailing the processed files with their original sources, tokens, and UUIDs.

```JSON
{
  "problems": {
    "13cd56e2-f6d7-4c66-ab1b-ffd13cd6646d": "Bad path \"13cd56e2-f6d7-4c66-ab1b-ffd13cd6646d\". Use UUID or CDN URL"
  },
  "result": [
    {
      "original_source": "d52d7136-a2e5-4338-9f45-affbf83b857d/video/-/format/ogg/-/quality/best/",
      "token": 445630631,
      "thumbnails_group_uuid": "575ed4e8-f4e8-4c14-a58b-1527b6d9ee46~1",
      "uuid": "d52d7136-a2e5-4338-9f45-affbf83b857d"
    },
    {
      "original_source": "500196bc-9da5-4aaf-8f3e-70a4ce86edae/video/",
      "token": 445630637,
      "thumbnails_group_uuid": "be3b4d5e-179d-460e-8a5d-69112ac86cbb~1",
      "uuid": "28843a09-dd3d-4b8a-ad4f-8aa5f8f60ff2"
    }
  ]
}
```
Tokens:
Raw