CloudConvert

CloudConvert integration (Productivity, Design & Media). Imported from open-connector.

API key14 toolshttps://sync.api.cloudconvert.com/v2

GET

cloudconvert_get_current_user

Get the current CloudConvert user and remaining credits for the API token.

/users/me

GET

cloudconvert_list_conversion_types

List possible CloudConvert conversion types for the requested input and output formats.

/convert/formats

7 parameters

Param	Type	Required	Description
inputFormat	string	optional	File format such as `pdf`, `docx`, or `png`.
outputFormat	string	optional	File format such as `pdf`, `docx`, or `png`.
engine	string	optional	Optional engine filter.
engineVersion	string	optional	Optional engine version filter.
alternatives	boolean	optional	Whether to include alternative engines for the same format pair.
includeOptions	boolean	optional	Whether to include conversion option descriptors in the response.
includeEngineVersions	boolean	optional	Whether to include compatible engine version descriptors in the response.

POST

cloudconvert_create_url_conversion_job

Create a CloudConvert job that imports a remote file URL, converts it, and exports the result via `export/url`.

/jobs

13 parameters

Param	Type	Required	Description
sourceUrl	string	required	Remote file URL that CloudConvert should import.
sourceFilename	string	optional	Optional file name override used for the imported source.
sourceHeaders	object	optional	String-to-string map forwarded to CloudConvert.
inputFormat	string	optional	File format such as `pdf`, `docx`, or `png`.
outputFormat	string	required	File format such as `pdf`, `docx`, or `png`.
engine	string	optional	Optional CloudConvert engine name.
engineVersion	string	optional	Optional CloudConvert engine version.
conversionOptions	object	optional	Additional `convert` task options forwarded to CloudConvert as-is, excluding re…
outputFilename	string	optional	Optional file name for the exported result.
inline	boolean	optional	Whether the exported file should be marked for inline display when possible.
archiveMultipleFiles	boolean	optional	Whether CloudConvert should archive multiple exported files when needed.
jobTag	string	optional	Optional tag stored on the created job.
webhookUrl	string	optional	Optional webhook URL CloudConvert should call for job status updates.

POST

cloudconvert_create_url_conversion_job_and_wait

Create a URL-based CloudConvert conversion job and wait synchronously until the job finishes.

/jobs

13 parameters

Param	Type	Required	Description
sourceUrl	string	required	Remote file URL that CloudConvert should import.
sourceFilename	string	optional	Optional file name override used for the imported source.
sourceHeaders	object	optional	String-to-string map forwarded to CloudConvert.
inputFormat	string	optional	File format such as `pdf`, `docx`, or `png`.
outputFormat	string	required	File format such as `pdf`, `docx`, or `png`.
engine	string	optional	Optional CloudConvert engine name.
engineVersion	string	optional	Optional CloudConvert engine version.
conversionOptions	object	optional	Additional `convert` task options forwarded to CloudConvert as-is, excluding re…
outputFilename	string	optional	Optional file name for the exported result.
inline	boolean	optional	Whether the exported file should be marked for inline display when possible.
archiveMultipleFiles	boolean	optional	Whether CloudConvert should archive multiple exported files when needed.
jobTag	string	optional	Optional tag stored on the created job.
webhookUrl	string	optional	Optional webhook URL CloudConvert should call for job status updates.

GET

cloudconvert_get_job

Get a single CloudConvert job and include its tasks.

/jobs/{jobId}

1 parameter

Param	Type	Required	Description
jobId	string	required	The CloudConvert job ID.

GET

cloudconvert_wait_for_job

Wait synchronously for a CloudConvert job to finish and return the finished or failed job with tasks.

/jobs/{jobId}

1 parameter

Param	Type	Required	Description
jobId	string	required	The CloudConvert job ID.

GET

cloudconvert_list_jobs

List CloudConvert jobs for the current account.

/jobs

4 parameters

Param	Type	Required	Description
status	string	optional	CloudConvert status filter such as `waiting`, `processing`, `finished`, `error`…
tag	string	optional	Optional job tag filter.
page	integer	optional	Page number to request from CloudConvert.
perPage	integer	optional	Number of items to request per CloudConvert page.

DELETE

cloudconvert_delete_job

Delete a CloudConvert job, including all tasks and related data.

/jobs/{jobId}

1 parameter

Param	Type	Required	Description
jobId	string	required	The CloudConvert job ID.

GET

cloudconvert_get_task

Get a single CloudConvert task by ID.

/tasks/{taskId}

1 parameter

Param	Type	Required	Description
taskId	string	required	The CloudConvert task ID.

GET

cloudconvert_wait_for_task

Wait synchronously for a CloudConvert task to finish and return the finished or failed task.

/tasks/{taskId}

1 parameter

Param	Type	Required	Description
taskId	string	required	The CloudConvert task ID.

GET

cloudconvert_list_tasks

List CloudConvert tasks for the current account.

/tasks

5 parameters

Param	Type	Required	Description
jobId	string	optional	The CloudConvert job ID.
status	string	optional	CloudConvert status filter such as `waiting`, `processing`, `finished`, `error`…
operation	string	optional	Optional task operation filter.
page	integer	optional	Page number to request from CloudConvert.
perPage	integer	optional	Number of items to request per CloudConvert page.

POST

cloudconvert_cancel_task

Cancel a CloudConvert task that is still waiting or processing.

/tasks/{taskId}/cancel

1 parameter

Param	Type	Required	Description
taskId	string	required	The CloudConvert task ID.

POST

cloudconvert_retry_task

Retry a CloudConvert task by creating a new task from the original payload.

/tasks/{taskId}/retry

1 parameter

Param	Type	Required	Description
taskId	string	required	The CloudConvert task ID.

DELETE

cloudconvert_delete_task

Delete a CloudConvert task, including all related data.

/tasks/{taskId}

1 parameter

Param	Type	Required	Description
taskId	string	required	The CloudConvert task ID.