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

# CloudConvert API

This page describes a curated, agent-optimized Jentic specification for CloudConvert API, kept validated and agent-ready. Microsoft's Power Platform certified-connector registry also carries a Swagger 2.0 connector definition for CloudConvert, which wraps four pre-composed flow actions plus format and option discovery rather than the general-purpose v2 REST API described here. CloudConvert is a cloud-based file conversion service that handles documents, images, video, audio, ebooks, archives, spreadsheets, and presentations across hundreds of formats. The v2 API models work as Jobs composed of Tasks (import, convert, export) and exposes regional endpoints for EU and US data residency. Authentication uses bearer tokens with scoped permissions.

## For AI agents

Convert files between hundreds of formats by composing import, convert, and export tasks into a CloudConvert job using a bearer token.

## Scope

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

## Capabilities

- Create conversion jobs that chain import, convert, and export tasks
- Wait synchronously for a job to finish via /jobs/{id}/wait
- Upload source files directly through /import/upload or pull from a URL
- List supported operations and target formats from /operations
- Manage webhooks to receive job and task status callbacks
- Retrieve authenticated user details and credit usage from /users/me

## Use cases

### PDF Document Conversion

Convert PDFs into editable formats like DOCX, XLSX, or images for downstream processing. Build a Job with an import-url task, a convert task targeting the destination format, and an export-url task to retrieve the result. Polling /jobs/{id}/wait blocks until the chain completes, typically in seconds for single-page documents.

Example prompt: POST /jobs with tasks=[import-url, convert(input_format=pdf, output_format=docx), export-url], then GET /jobs/{id}/wait and return the export URL.

### Video and Audio Transcoding

Re-encode media files between codecs and containers. CloudConvert supports MP4, MOV, WebM, MP3, WAV, FLAC, and many more formats. A single job can chain a transcode plus a thumbnail extraction so a content pipeline gets both deliverables in one call.

Example prompt: POST /jobs with a convert task input_format=mp4, output_format=webm, video_codec=vp9 and a thumbnail task, then GET /jobs/{id}/wait.

### Bulk Office Document Processing

Process spreadsheets, presentations, and Word documents in batch - for example converting an upload folder of XLSX files to PDF for archival. Combine /import/upload, /jobs, and webhooks so the application is notified asynchronously when each job completes rather than polling.

Example prompt: POST /import/upload for each file, POST /jobs to convert to pdf, register a webhook via POST /webhooks, and listen for job.finished events.

### AI Agent File Conversion

Let a Jentic-powered agent convert user-uploaded files on demand. The agent searches Jentic for 'convert a file format', loads the CloudConvert createJob operation, and executes a job with the source URL and target format. The bearer token stays in your Jentic One instance.

Example prompt: Search Jentic for 'convert a PDF to DOCX', load the CloudConvert createJob operation, and execute it with the source URL and output_format=docx.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /jobs | Create a conversion job with chained tasks |
| GET | /jobs/{id} | Get job status and tasks |
| GET | /jobs/{id}/wait | Wait synchronously for job completion |
| POST | /import/upload | Create an upload task for a source file |
| POST | /import/url | Import a file from a public URL |
| GET | /operations | List supported conversion operations |
| POST | /webhooks | Register a webhook for job events |
| GET | /users/me | Get authenticated user and credit balance |

## Key resources

- **Jobs** — Top-level conversion units composed of tasks at /jobs.
- **Tasks** — Individual import, convert, or export steps at /tasks.
- **Operations** — Discovery of supported conversions at /operations.
- **Webhooks** — Async notifications for job and task lifecycle events at /webhooks.
- **Users** — Authenticated user and credit information at /users/me.

## Why Jentic

- **Setup:** Wiring the CloudConvert API by hand means setting up its bearer auth, choosing among the default, eu-central, and us-east hosts, and composing the import, convert, and export task chain yourself. Through Jentic you install once, import the CloudConvert API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** CloudConvert's job and operation 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, importing a file, or waiting on a result. You choose that set, so operations like registering a webhook are only in reach if you include them.
- **Credential handling:** Your CloudConvert token 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 PDF to DOCX' or 'transcode a video', and Jentic returns the create-job operation with its task schema so the agent composes the correct task chain without browsing the reference docs.

## Related APIs

- **CloudConvert API** — Alternate import of the CloudConvert v2 spec with OAuth2 and sandbox server.
- **Filestack** — File upload, transformation, and conversion as a single managed service.
- **Cloudinary Upload API** — Image and video CDN with on-the-fly format conversion at delivery time.

## FAQ

### Which OpenAPI specification does this CloudConvert API page describe?

A curated, agent-optimized Jentic specification covering 14 CloudConvert API operations, validated against the live v2 API. CloudConvert's own hosts serve no OpenAPI document: its llms.txt lists 22 documentation pages with zero openapi, swagger or .yaml references, /openapi.json, /openapi.yaml and /swagger.json all return 404 on both cloudconvert.com and api.cloudconvert.com, and the vendor ships an MCP server instead (checked 2026-08-13). A Swagger 2.0 connector definition for CloudConvert is published in Microsoft's Power Platform certified-connector registry at https://raw.githubusercontent.com/microsoft/PowerPlatformConnectors/dev/certified-connectors/CloudConvert/apiDefinition.swagger.json, which targets host api.cloudconvert.com and covers 14 connector operations: four pre-composed flow actions (convert a file, optimize, capture a website, merge) plus format, option and input discovery. That is not the full CloudConvert REST API, so the Jentic specification is the broader description of the v2 surface, covering job and task composition, uploads and URL imports, webhooks, and account credit. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the CloudConvert API use?

The API uses bearer token authentication. Generate an API token in the CloudConvert dashboard, scope it to the operations you need, and pass it as Authorization: Bearer <token>. Through Jentic, the token is stored encrypted and never enters the agent's context.

### How do I convert a PDF to DOCX with the CloudConvert API?

Create a job at POST /jobs with three tasks: an import task (import-url or import-upload), a convert task with input_format=pdf and output_format=docx, and an export-url task. Then call GET /jobs/{id}/wait to receive the export URL when it completes.

### Can the CloudConvert API notify my app when a job finishes?

Yes. Register a webhook via POST /webhooks subscribing to job.finished or task.finished events. CloudConvert posts the event payload to your URL so you avoid polling /jobs/{id}.

### 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 import source and target format. Jentic handles the bearer token from the stored credential.

### Does CloudConvert have regional endpoints for data residency?

Yes. The spec lists EU (https://eu-central.api.cloudconvert.com) and US (https://us-east.api.cloudconvert.com) base URLs in addition to the global https://api.cloudconvert.com/v2. Pick the regional host to keep file processing inside a specific region.

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

Yes. Because you run Jentic One yourself, you decide exactly which CloudConvert operations your agent may call, so you can grant creating a job, importing a file, and waiting on a result while withholding anything else. CloudConvert's job and operation ids are ephemeral rather than fixed resources, so scoping is done at the operation level rather than by pinning ids in the URL path. Operations such as registering a webhook are only in reach if you explicitly include them, and your bearer token is injected at execution time without entering the agent's context.
