canonical: https://jentic.com/apis/cloudconvertcom/cloudconvertcom

# Cloudconvertcom CloudConvert API

Jentic publishes the only available OpenAPI specification for CloudConvert API, keeping it validated and agent-ready. CloudConvert is an online file conversion service supporting nearly all audio, video, document, ebook, archive, image, spreadsheet, and presentation formats. This variant of the spec adds OAuth2 user-delegated auth alongside personal bearer tokens and exposes a sandbox base URL for safe testing. Conversions are modelled as Jobs containing import, convert, and export Tasks, with webhook callbacks for async completion.

## For AI agents

Convert files between hundreds of formats and manage webhooks on CloudConvert using bearer tokens or OAuth2.

## Scope

Does not host long-term file storage, perform OCR text extraction, or render real-time previews - use for file format conversion only.

## Capabilities

- Create conversion jobs that chain import, convert, and export tasks
- Cancel or retry an in-flight task at `/tasks/{taskId}/cancel` and `/tasks/{taskId}/retry`
- Wait synchronously for a job to finish via `/jobs/{jobId}/wait`
- List, register, and delete webhooks for job and task lifecycle events
- Authenticate end users via OAuth2 to convert files in their CloudConvert account
- Inspect individual tasks and jobs by ID for status and output URLs

## Use cases

### User-Delegated File Conversion

Build a SaaS feature that converts files inside a customer's own CloudConvert account using OAuth2. The user authorises the app, the access token is stored, and the app calls /jobs on their behalf. Job credits and storage are billed to the user, not the app developer.

Example prompt: Complete the OAuth2 flow for the user, then POST /jobs with the import, convert, and export tasks under their token.

### Resilient Conversion Pipeline

Run conversions with retry and cancellation for production workloads. Use `/tasks/{taskId}/retry` when a transient failure occurs and `/tasks/{taskId}/cancel` to abort jobs whose source is no longer needed. Webhooks at /webhooks notify the orchestrator when each task transitions state.

Example prompt: On task.failed webhook, call POST `/tasks/{taskId}/retry`; on user cancellation, call POST `/tasks/{taskId}/cancel.`

### Sandbox Testing Before Production

Use the CloudConvert sandbox base URL (https://sandbox.api.cloudconvert.com/v2) to validate task chains without consuming production credits or producing watermark-free output. Once the workflow is correct, swap the base URL to api.cloudconvert.com/v2.

Example prompt: Point the client at https://sandbox.api.cloudconvert.com/v2, POST /jobs to validate the task chain, then redeploy against the production base URL.

### AI Agent File Conversion via OAuth

Let a Jentic-powered agent convert a file inside the end user's CloudConvert account. The agent searches Jentic for 'convert a file', loads the createJob operation, and executes against the OAuth-issued token rather than a global app token. Jentic isolates each user's credential.

Example prompt: Search Jentic for 'convert file with CloudConvert', load createJob, and execute with the user's OAuth access token and chosen output_format.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/jobs` | Create a conversion job with chained tasks |
| GET | `/jobs/{jobId}` | Get job status and tasks |
| GET | `/jobs/{jobId}/wait` | Wait for job completion |
| GET | `/tasks/{taskId}` | Get a single task |
| POST | `/tasks/{taskId}/cancel` | Cancel a running task |
| POST | `/tasks/{taskId}/retry` | Retry a failed task |
| POST | `/webhooks` | Register a webhook |
| GET | `/users/me/webhooks` | List webhooks for the authenticated user |

## Key resources

- **Jobs** — Conversion jobs at /jobs and `/jobs/{jobId}.`
- **Tasks** — Individual import, convert, export tasks at /tasks with cancel and retry actions.
- **Webhooks** — Account-level and per-user webhook subscriptions at /webhooks and `/users/me/webhooks.`

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 73 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 93 / 100
  - Developer Experience & Jentic Compatibility: 61 / 100
  - AI-Readiness & Agent Experience: 56 / 100
  - Agent Usability: 94 / 100
  - Security: 75 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/cloudconvertcom/cloudconvertcom/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the CloudConvert API by hand means handling both personal bearer tokens and OAuth2 access tokens, choosing among the default, eu-central, and us-east hosts, and driving the job and task lifecycle yourself. Through Jentic you install once, import the CloudConvert API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** CloudConvert's job and task ids are ephemeral rather than persistent resources you would pin in the URL path, so scope the agent by the operations it needs, such as creating a job or reading a task. You choose that set, so operations like cancelling or retrying a task, or registering a webhook, are only in reach if you include them.
- **Credential handling:** Your CloudConvert bearer or OAuth2 credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'convert a file' or 'cancel a conversion task', and Jentic returns the matching CloudConvert operation with its input schema so the agent calls the right /jobs or /tasks endpoint without browsing the reference docs.

## Related APIs

- **CloudConvert API** — Alternate import of the CloudConvert v2 spec with bearer-only auth and operations discovery.
- **Filestack** — File upload, transformation, and conversion in a single managed product.
- **Cloudinary Upload API** — Media CDN with format conversion at delivery time.

## FAQ

### Why is there no official OpenAPI spec for CloudConvert API?

CloudConvert does not publish a structured OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call CloudConvert API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the CloudConvert API use?

The spec defines two schemes: a personal bearer token for first-party apps and an OAuth2 flow for user-delegated access. Both are passed as Authorization: Bearer <token>. Through Jentic, tokens are stored encrypted and injected at execution time.

### Can I retry a failed CloudConvert task?

Yes. POST `/tasks/{taskId}/retry` re-runs a failed task with the same parameters and produces a new task ID. This is the standard recovery path for transient errors such as upstream import failures.

### How do I cancel a running CloudConvert job?

Cancel each pending task with POST `/tasks/{taskId}/cancel.` Tasks that have already completed cannot be cancelled, but pending and running tasks transition to a cancelled state and stop consuming credits.

### How do I run a CloudConvert job through Jentic?

Run jentic search 'convert a file with CloudConvert', load the createJob operation, and execute with the source URL and output_format. Jentic handles the bearer or OAuth2 token from the stored credential.

### Is there a sandbox environment for CloudConvert?

Yes. The spec lists https://sandbox.api.cloudconvert.com/v2 as a server. Use it to validate task chains and webhook flows before pointing the client at the production https://api.cloudconvert.com/v2 base URL.

### Can I limit what my agent is allowed to do with the CloudConvert API?

Yes. Because your Jentic One instance is self-hosted, your own rules decide which CloudConvert operations and credentials the agent can use. CloudConvert's job and task IDs are ephemeral rather than fixed resources, so you scope the agent by the operations you grant it, such as creating a job or reading a task. Operations like cancelling or retrying a task or registering a webhook are only reachable if you choose to include them.