Complete reference documentation for the Uploadcare's REST API. Covers endpoints, requests, their parameters, and response examples.

Uploadcare REST API Reference

REST API v0.7

Authentication

Simple authentication over HTTP is forbidden. Please, use HTTPS or signed requests instead.

with-appdata

without-appdata

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

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

List of files

Store file

removed-file

Delete file

Get file information by its UUID (immutable).

Image

Video

File info

Used to store multiple files in one go. Up to 100 files are supported per request. A JSON object holding your File list SHOULD be put into a request body.

Batch file storing

Batch file delete

Copy file to local storage

Simple HTTP auth. on HTTP or file copy errors.

Copy file to remote storage

File

Get file's metadata

Get metadata key's value

Update the value of a single metadata key. If the key does not exist, it will be created.

Update metadata key's value

Delete metadata key

File metadata

list

A preferred amount of groups in a list for a single response.
Defaults to 100, while the maximum is 1000.

A starting point for filtering the list of groups.
If passed, MUST be a date and time value in ISO-8601 format.

List of groups

Group info

Delete group

Group

Execute AWS Rekognition

Request ID returned by the Add-On execution request described above.

Check AWS Rekognition execution status

Execute AWS Rekognition Moderation

Check AWS Rekognition Moderation execution status

Execute ClamAV

Check ClamAV execution status

Execute Remove.bg

Check Remove.bg execution status

Add-Ons

Project info

Project

Simple HTTP Auth or webhook permission errors.

List of webhooks

Create and subscribe to a webhook. You can use webhooks to receive notifications about your uploads. For instance, once a file gets uploaded to your project, we can notify you by sending a message to a target URL.

Simple HTTP Auth or webhook permission or endpoint errors.

Create webhook

Update webhook

Delete webhook

Webhook

file.uploaded

file.infected

file.stored

file.deleted

file.info_updated

Webhook Callbacks

The endpoint allows you to determine the document format and possible conversion formats.

Simple HTTP Auth or document conversion permission errors.

Document info

Convert document

Document conversion job status

Uploadcare video processing adjusts video quality, format (mp4, webm, ogg), and size, cuts it, and generates thumbnails. Processed video is instantly available over CDN.

Simple HTTP Auth or video conversion permission errors.

Convert video

Video conversion job status

Conversion

Changelog

Versioning

AddonExecutionStatus

AddonExecutionStatusStatus

ApplicationData

Date and time when an application data was created.

Date and time when an application data was updated.

Dictionary with a result of an application execution result.

Dictionary of application names and data associated with these applications.

ApplicationDataObject

AwsRekognitionDetectLabelsV20160627

Dictionary with a result of an aws rekognition detect labels execution result.

AwsRekognitionDetectLabelsV20160627Data

AwsRekognitionDetectLabelsV20160627DataLabelsItem

AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItem

AwsRekognitionDetectLabelsV20160627DataLabelsItemInstancesItemBoundingBox

AwsRekognitionDetectLabelsV20160627DataLabelsItemParentsItem

AwsRekognitionDetectModerationLabelsExecuteRequestConflictErrorBody

AwsRekognitionDetectModerationLabelsExecuteRequestNotAcceptableErrorBody

AwsRekognitionDetectModerationLabelsExecuteRequestTooManyRequestsErrorBody

AwsRekognitionDetectModerationLabelsExecuteRequestUnauthorizedErrorBody

AwsRekognitionDetectModerationLabelsExecutionStatusRequestNotAcceptableErrorBody

AwsRekognitionDetectModerationLabelsExecutionStatusRequestUnauthorizedErrorBody

AwsRekognitionDetectModerationLabelsV20160627

Dictionary with a result of an aws rekognition detect moderation labels execution result.

AwsRekognitionDetectModerationLabelsV20160627Data

AwsRekognitionDetectModerationLabelsV20160627DataModerationLabelsItem

AwsRekognitionExecuteRequestConflictErrorBody

AwsRekognitionExecuteRequestNotAcceptableErrorBody

AwsRekognitionExecuteRequestTooManyRequestsErrorBody

AwsRekognitionExecuteRequestUnauthorizedErrorBody

AwsRekognitionExecutionStatusRequestNotAcceptableErrorBody

AwsRekognitionExecutionStatusRequestUnauthorizedErrorBody

BadRequestErrorBodyDetail

BadRequestErrorBodyDetailDetail

CantUseDocsConversionError

CantUseVideoConversionError

CantUseWebhooksError

ContentInfo

ContentInfoMime

CopiedFileUrl

URL with an s3 scheme. Your bucket name is put as a host, and an s3 object path follows.

CreateLocalCopyRequestBadRequestErrorBody

CreateLocalCopyRequestNotAcceptableErrorBody

CreateLocalCopyRequestTooManyRequestsErrorBody

CreateLocalCopyRequestUnauthorizedErrorBody

CreateRemoteCopyRequestBadRequestErrorBody

CreateRemoteCopyRequestNotAcceptableErrorBody

CreateRemoteCopyRequestTooManyRequestsErrorBody

CreateRemoteCopyRequestUnauthorizedErrorBody

DeleteFileMetadataKeyRequestNotAcceptableErrorBody

DeleteFileMetadataKeyRequestUnauthorizedErrorBody

DeleteFileStorageRequestNotAcceptableErrorBody

DeleteFileStorageRequestNotFoundErrorBody

DeleteFileStorageRequestTooManyRequestsErrorBody

DeleteFileStorageRequestUnauthorizedErrorBody

DeleteGroupRequestNotAcceptableErrorBody

DeleteGroupRequestNotFoundErrorBody

DeleteGroupRequestTooManyRequestsErrorBody

DeleteGroupRequestUnauthorizedErrorBody

DocumentConvertInfoRequestBadRequestErrorBody

DocumentConvertInfoRequestNotAcceptableErrorBody

DocumentConvertInfoRequestNotFoundErrorBody

DocumentConvertInfoRequestTooManyRequestsErrorBody

DocumentConvertInfoRequestUnauthorizedErrorBody

DocumentConvertRequestBadRequestErrorBody

DocumentConvertRequestNotAcceptableErrorBody

DocumentConvertRequestUnauthorizedErrorBody

DocumentConvertStatusRequestBadRequestErrorBody

DocumentConvertStatusRequestNotAcceptableErrorBody

DocumentConvertStatusRequestNotFoundErrorBody

DocumentConvertStatusRequestTooManyRequestsErrorBody

DocumentConvertStatusRequestUnauthorizedErrorBody

Date and time when a file was removed, if any.

Date and time of the last store request, if any.

Is file is ready to be used after upload.

Publicly available file CDN URL. Available if a file is not deleted.

Original file name taken from uploaded file.

FileCopy

FileCopyErrors

FileCopyErrorsDetail

FileInfoRequestNotAcceptableErrorBody

FileInfoRequestNotFoundErrorBody

FileInfoRequestTooManyRequestsErrorBody

FileInfoRequestUnauthorizedErrorBody

FileMetadataKeyRequestNotAcceptableErrorBody

FileMetadataKeyRequestUnauthorizedErrorBody

FileMetadataRequestNotAcceptableErrorBody

FileMetadataRequestUnauthorizedErrorBody

FilesDeleteRequestBadRequestErrorBody

FilesDeleteRequestNotAcceptableErrorBody

FilesDeleteRequestTooManyRequestsErrorBody

FilesDeleteRequestUnauthorizedErrorBody

FilesListRequestNotAcceptableErrorBody

FilesListRequestTooManyRequestsErrorBody

FilesListRequestUnauthorizedErrorBody

FilesStoringRequestBadRequestErrorBody

FilesStoringRequestNotAcceptableErrorBody

FilesStoringRequestTooManyRequestsErrorBody

FilesStoringRequestUnauthorizedErrorBody

ISO-8601 date and time when the group was created.

GroupInfoRequestNotAcceptableErrorBody

GroupInfoRequestNotFoundErrorBody

GroupInfoRequestTooManyRequestsErrorBody

GroupInfoRequestUnauthorizedErrorBody

GroupWithFiles

The list of files in the group. An array may contain null values if a file has been removed.

GroupsListRequestNotAcceptableErrorBody

GroupsListRequestTooManyRequestsErrorBody

GroupsListRequestUnauthorizedErrorBody

ImageInfo

Set to true if a file contains a sequence of images (GIF for example).

Image date and time from EXIF. Please be aware that this data is not always formatted and displayed exactly as it appears in the EXIF.

1	curl -X POST https://api.uploadcare.com/addons/uc_clamav_virus_scan/execute/ \
2	-H "Accept: application/vnd.uploadcare-v0.7+json" \
3	-H "Authorization: <apiKey>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"target": "21975c81-7f57-4c7a-aef9-acfe28779f78"
7	}'

Execute ClamAV

Headers

Request

Response

Errors