Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Uploadcare Add-Ons API

An `Add-On` is an application implemented by Uploadcare that accepts uploaded files as aninput and can produce other files and/or [appdata](#operation/fileInfo) as an output.

Uploadcare Add-Ons API is one of 11 APIs that Uploadcare publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Add-Ons. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 8 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 2022-11-28.

Requests are made against a single base URL, https://ucarecdn.com.

8 operations 8 paths 2 schemas 4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2022-11-28
Base URL
https://api.uploadcare.com
Resource Areas
1

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Add-Ons 8

An Add-On is an application implemented by Uploadcare that accepts uploaded files as an input and can produce other files and/or [appdata](operation/fileInfo) as an output.

POST
/addons/aws_rekognition_detect_labels/execute/
Execute AWS Rekognition
awsRekognitionExecute 1 param body → 200400401406409429
GET
/addons/aws_rekognition_detect_labels/execute/status/
Check AWS Rekognition execution status
awsRekognitionExecutionStatus 2 params → 200400401406
POST
/addons/aws_rekognition_detect_moderation_labels/execute/
Execute AWS Rekognition Moderation
awsRekognitionDetectModerationLabelsExecute 1 param body → 200400401406409429
GET
/addons/aws_rekognition_detect_moderation_labels/execute/status/
Check AWS Rekognition Moderation execution status
awsRekognitionDetectModerationLabelsExecutionStatus 2 params → 200400401406
POST
/addons/uc_clamav_virus_scan/execute/
Execute ClamAV
ucClamavVirusScanExecute 1 param body → 200400401406409429
GET
/addons/uc_clamav_virus_scan/execute/status/
Check ClamAV execution status
ucClamavVirusScanExecutionStatus 2 params → 200400401406
POST
/addons/remove_bg/execute/
Execute Remove.bg
removeBgExecute 1 param body → 200400401406409429
GET
/addons/remove_bg/execute/status/
Check Remove.bg execution status
removeBgExecutionStatus 2 params → 200400401406

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are simpleAuthHTTPForbidden (1 property), addonExecutionStatus (1 property). Each schema is shown below with its type and property counts.

addonExecutionStatus
object
1 property
simpleAuthHTTPForbidden
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

uploadcare-add-ons-api-openapi.yml Raw ↑

Other APIs Uploadcare publishes across the network.

Uploadcare Upload API
Uploadcare Conversion API
Uploadcare File API
Uploadcare File information API
Uploadcare File metadata API
Uploadcare File names API
Uploadcare Group API
Uploadcare Groups API
Uploadcare Project API
Uploadcare Webhook API