> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://uploadcare.com/docs/api/rest/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://uploadcare.com/docs/_mcp/server.

# Uploadcare REST API Reference

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

REST API provides low-level access to Uploadcare features. You can manage files and their metadata, application data, file groups, add-ons, projects, webhooks, file conversions, and video encoding.

For high-level integrations and SDKs, see [available libraries](/docs/integrations/).

### API endpoints

REST API root endpoint: `https://api.uploadcare.com/`

Send data via query strings and POST request bodies, and receive JSON responses.

**Note**: All API endpoints must end with a forward slash `/`.

```text
GET /files/
PUT /files/{uuid}/storage/
POST /files/local_copy/
...
```

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

## Docs

- [Authentication](https://uploadcare.com/docs/api/rest/authentication.md)
- [File Metadata](https://uploadcare.com/docs/api/rest/file-metadata.md)
- [File Tags](https://uploadcare.com/docs/api/rest/file-tags.md)
- [Add Ons](https://uploadcare.com/docs/api/rest/add-ons.md)
- [Changelog](https://uploadcare.com/docs/api/rest/changelog.md)
- [Versioning](https://uploadcare.com/docs/api/rest/versioning.md)

## API Docs

- REST API > File [List of files](https://uploadcare.com/docs/api/rest/file/files-list.md)
- REST API > File [Store file](https://uploadcare.com/docs/api/rest/file/store-file.md)
- REST API > File [Delete file](https://uploadcare.com/docs/api/rest/file/delete-file-storage.md)
- REST API > File [File info](https://uploadcare.com/docs/api/rest/file/info.md)
- REST API > File [Batch file storing](https://uploadcare.com/docs/api/rest/file/files-storing.md)
- REST API > File [Batch file delete](https://uploadcare.com/docs/api/rest/file/files-delete.md)
- REST API > File [Copy file to local storage](https://uploadcare.com/docs/api/rest/file/create-local-copy.md)
- REST API > File [Copy file to remote storage](https://uploadcare.com/docs/api/rest/file/create-remote-copy.md)
- REST API > File [Search files](https://uploadcare.com/docs/api/rest/file/search-files.md)
- REST API > File Metadata [Get file's metadata](https://uploadcare.com/docs/api/rest/file-metadata/file-metadata.md)
- REST API > File Metadata [Get metadata key's value](https://uploadcare.com/docs/api/rest/file-metadata/key.md)
- REST API > File Metadata [Update metadata key's value](https://uploadcare.com/docs/api/rest/file-metadata/update-file-metadata-key.md)
- REST API > File Metadata [Delete metadata key](https://uploadcare.com/docs/api/rest/file-metadata/delete-file-metadata-key.md)
- REST API > File Tags [Get file tags](https://uploadcare.com/docs/api/rest/file-tags/get-tags.md)
- REST API > File Tags [Replace file tags](https://uploadcare.com/docs/api/rest/file-tags/put-tags.md)
- REST API > File Tags [Add or remove file tags](https://uploadcare.com/docs/api/rest/file-tags/patch-tags.md)
- REST API > Group [List of groups](https://uploadcare.com/docs/api/rest/group/groups-list.md)
- REST API > Group [Group info](https://uploadcare.com/docs/api/rest/group/info.md)
- REST API > Group [Delete group](https://uploadcare.com/docs/api/rest/group/delete-group.md)
- REST API > Add Ons [Execute AWS Rekognition](https://uploadcare.com/docs/api/rest/add-ons/aws-rekognition-execute.md)
- REST API > Add Ons [Check AWS Rekognition execution status](https://uploadcare.com/docs/api/rest/add-ons/aws-rekognition-execution-status.md)
- REST API > Add Ons [Execute AWS Rekognition Moderation](https://uploadcare.com/docs/api/rest/add-ons/aws-rekognition-detect-moderation-labels-execute.md)
- REST API > Add Ons [Check AWS Rekognition Moderation execution status](https://uploadcare.com/docs/api/rest/add-ons/aws-rekognition-detect-moderation-labels-execution-status.md)
- REST API > Add Ons [Execute ClamAV](https://uploadcare.com/docs/api/rest/add-ons/uc-clamav-virus-scan-execute.md)
- REST API > Add Ons [Check ClamAV execution status](https://uploadcare.com/docs/api/rest/add-ons/uc-clamav-virus-scan-execution-status.md)
- REST API > Add Ons [Execute Remove.bg](https://uploadcare.com/docs/api/rest/add-ons/remove-bg-execute.md)
- REST API > Add Ons [Check Remove.bg execution status](https://uploadcare.com/docs/api/rest/add-ons/remove-bg-execution-status.md)
- REST API > Project [Project info](https://uploadcare.com/docs/api/rest/project/info.md)
- REST API > Webhook [List of webhooks](https://uploadcare.com/docs/api/rest/webhook/webhooks-list.md)
- REST API > Webhook [Create webhook](https://uploadcare.com/docs/api/rest/webhook/create.md)
- REST API > Webhook [Update webhook](https://uploadcare.com/docs/api/rest/webhook/update-webhook.md)
- REST API > Webhook [Delete webhook](https://uploadcare.com/docs/api/rest/webhook/unsubscribe.md)
- REST API > Conversion [Document info](https://uploadcare.com/docs/api/rest/conversion/document-convert-info.md)
- REST API > Conversion [Convert document](https://uploadcare.com/docs/api/rest/conversion/document-convert.md)
- REST API > Conversion [Document conversion job status](https://uploadcare.com/docs/api/rest/conversion/document-convert-status.md)
- REST API > Conversion [Convert video](https://uploadcare.com/docs/api/rest/conversion/video-convert.md)
- REST API > Conversion [Video conversion job status](https://uploadcare.com/docs/api/rest/conversion/video-convert-status.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://uploadcare.com/docs/api/rest/openapi.json)
- [OpenAPI YAML](https://uploadcare.com/docs/api/rest/openapi.yaml)