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
    • 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
On this page
  • Download OpenAPI specs
  • Upload API
  • REST API
  • REST API versioning
  • URL API

APIs overview

Was this page helpful?

Uploadcare Upload API Reference

Next
Built with

Three APIs for your entire file pipeline:

  • Upload API
  • REST API
  • URL API

APIs come with integrations for the most popular programming languages and frameworks.

Download OpenAPI specs

Each download is a single-file OpenAPI YAML bundle.

  • Upload API spec
  • REST API spec
  • URL API spec

Upload API

Upload files to Uploadcare servers. Fast, secure, and reliable.

Key features:

  • Direct uploading
  • Multipart uploading
  • Uploading via URL
  • Signed uploads

Upload API powers our File Uploader and jQuery File Uploader.

Upload API reference → Upload API clients →

REST API

From basic CRUD operations to adding metadata, converting videos and documents, checking for viruses and running various add-ons.

Key features:

  • Secure authorization
  • File and groups management
  • File arbitrary metadata management
  • Video processing
  • Document conversion
  • Object recognition
  • Image background removal
  • Malware detection

REST API reference → REST API clients →

REST API versioning

REST API is a subject to versioning. When we introduce backward-incompatible changes, we release new major versions. Once published, such versions are supported for 2 years. See all REST API versions for more details.

URL API

Optimize, transform, and adjust images on the fly.

Key features:

  • Works on the fly
  • Image optimization
  • Image transformation
  • Image color adjustment
  • Image and text overlays
  • Face detection and color recognition
  • Getting file information
  • Signed URLs

URL API can be used with Proxy.

URL API reference →