Can I use CloudConvert as a CLI?

Yes. KosmoKrator exposes a CloudConvert CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose CloudConvert through MCP?

Yes. The KosmoKrator MCP gateway can expose selected CloudConvert tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are CloudConvert credentials stored?

CloudConvert credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for CloudConvert MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

files

CloudConvert CLI for AI Agents

Use the CloudConvert CLI from KosmoKrator to call CloudConvert tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

7 functions 5 read 2 write API key auth

Submit CloudConvert feedback View package source

CloudConvert CLI Setup

CloudConvert can be configured headlessly with `kosmokrator integrations:configure cloudconvert`.

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure cloudconvert --set api_key="$CLOUDCONVERT_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor cloudconvert --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

Key	Env var	Type	Required	Label
`api_key`	`CLOUDCONVERT_API_KEY`	Secret `secret`	yes	API Key
`url`	`CLOUDCONVERT_URL`	URL `url`	no	API Base URL

Call CloudConvert Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call cloudconvert.cloudconvert_create_job '{
  "tasks": "example_tasks",
  "tag": "example_tag",
  "webhook_url": "example_webhook_url"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:cloudconvert cloudconvert_create_job '{
  "tasks": "example_tasks",
  "tag": "example_tag",
  "webhook_url": "example_webhook_url"
}' --json

Agent Discovery Commands

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

kosmo integrations:docs cloudconvert --json
kosmo integrations:docs cloudconvert.cloudconvert_create_job --json
kosmo integrations:schema cloudconvert.cloudconvert_create_job --json
kosmo integrations:search "CloudConvert" --json
kosmo integrations:list --json

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to CloudConvert.

`cloudconvert.cloudconvert_create_job`

Write write

Create a new CloudConvert job. A job groups one or more tasks (import, convert, export) into a single workflow. Pass a tasks array to define the conversion pipeline.

Parameters: tasks, tag, webhook_url

Generic CLI call

kosmo integrations:call cloudconvert.cloudconvert_create_job '{"tasks":"example_tasks","tag":"example_tag","webhook_url":"example_webhook_url"}' --json

Provider shortcut

kosmo integrations:cloudconvert cloudconvert_create_job '{"tasks":"example_tasks","tag":"example_tag","webhook_url":"example_webhook_url"}' --json

`cloudconvert.cloudconvert_get_job`

Read read

Get details and status of a CloudConvert job by ID, including all associated tasks and their results.

Parameters: job_id

Generic CLI call

kosmo integrations:call cloudconvert.cloudconvert_get_job '{"job_id":"example_job_id"}' --json

Provider shortcut

kosmo integrations:cloudconvert cloudconvert_get_job '{"job_id":"example_job_id"}' --json

`cloudconvert.cloudconvert_list_jobs`

Read read

List CloudConvert jobs with optional filtering by status or tag, and pagination.

Parameters: per_page, page, status, tag

Generic CLI call

kosmo integrations:call cloudconvert.cloudconvert_list_jobs '{"per_page":1,"page":1,"status":"example_status","tag":"example_tag"}' --json

Provider shortcut

kosmo integrations:cloudconvert cloudconvert_list_jobs '{"per_page":1,"page":1,"status":"example_status","tag":"example_tag"}' --json

`cloudconvert.cloudconvert_create_task`

Write write

Create a standalone CloudConvert task. Specify an operation (e.g., import/url, convert, export/url, capture-website, merge, optimize, thumbnail) and the operation-specific payload.

Parameters: operation, payload, name, input

Generic CLI call

kosmo integrations:call cloudconvert.cloudconvert_create_task '{"operation":"example_operation","payload":"example_payload","name":"example_name","input":"example_input"}' --json

Provider shortcut

kosmo integrations:cloudconvert cloudconvert_create_task '{"operation":"example_operation","payload":"example_payload","name":"example_name","input":"example_input"}' --json

`cloudconvert.cloudconvert_get_task`

Read read

Get details and status of a CloudConvert task by ID, including the result payload with download URLs for completed conversions.

Parameters: task_id

Generic CLI call

kosmo integrations:call cloudconvert.cloudconvert_get_task '{"task_id":"example_task_id"}' --json

Provider shortcut

kosmo integrations:cloudconvert cloudconvert_get_task '{"task_id":"example_task_id"}' --json

`cloudconvert.cloudconvert_list_tasks`

Read read

List CloudConvert tasks with optional filtering by status, operation, or job ID, and pagination.

Parameters: per_page, page, status, operation, job_id

Generic CLI call

kosmo integrations:call cloudconvert.cloudconvert_list_tasks '{"per_page":1,"page":1,"status":"example_status","operation":"example_operation","job_id":"example_job_id"}' --json

Provider shortcut

kosmo integrations:cloudconvert cloudconvert_list_tasks '{"per_page":1,"page":1,"status":"example_status","operation":"example_operation","job_id":"example_job_id"}' --json

`cloudconvert.cloudconvert_get_current_user`

Read read

Get the authenticated CloudConvert user profile, including remaining credits and subscription info.

Parameters: none

Generic CLI call

kosmo integrations:call cloudconvert.cloudconvert_get_current_user '{}' --json

Provider shortcut

kosmo integrations:cloudconvert cloudconvert_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

`cloudconvert.cloudconvert_create_job`

Create a new CloudConvert job. A job groups one or more tasks (import, convert, export) into a single workflow. Pass a tasks array to define the conversion pipeline.

Operation: Write write
Schema command: kosmo integrations:schema cloudconvert.cloudconvert_create_job --json

Parameter	Type	Required	Description
`tasks`	array	yes	Array of task definitions. Each task is an object with "operation" (e.g., "import/url", "convert", "export/url"), optional "name", optional "input" (name of a previous task to chain from), and operation-specific parameters. Example: [{"operation": "import/url", "url": "https://example.com/file.pdf", "filename": "file.pdf"}, {"operation": "convert", "input": "import", "output_format": "png"}].
`tag`	string	no	Optional tag to identify and filter the job later.
`webhook_url`	string	no	Optional webhook URL called when the job finishes.

`cloudconvert.cloudconvert_get_job`

Get details and status of a CloudConvert job by ID, including all associated tasks and their results.

Operation: Read read
Schema command: kosmo integrations:schema cloudconvert.cloudconvert_get_job --json

Parameter	Type	Required	Description
`job_id`	string	yes	The CloudConvert job ID.

`cloudconvert.cloudconvert_list_jobs`

List CloudConvert jobs with optional filtering by status or tag, and pagination.

Operation: Read read
Schema command: kosmo integrations:schema cloudconvert.cloudconvert_list_jobs --json

Parameter	Type	Required	Description
`per_page`	integer	no	Number of jobs per page (default: 20, max: 100).
`page`	integer	no	Page number (default: 1).
`status`	string	no	Filter by status: waiting, processing, finished, error.
`tag`	string	no	Filter by job tag.

`cloudconvert.cloudconvert_create_task`

Create a standalone CloudConvert task. Specify an operation (e.g., import/url, convert, export/url, capture-website, merge, optimize, thumbnail) and the operation-specific payload.

Operation: Write write
Schema command: kosmo integrations:schema cloudconvert.cloudconvert_create_task --json

Parameter	Type	Required	Description
`operation`	string	yes	The task operation. Common operations: "import/url", "import/upload", "import/base64", "convert", "export/url", "export/aws-s3", "capture-website", "merge", "optimize", "thumbnail", "metadata", "archive".
`payload`	array	no	Operation-specific parameters. For "convert": output_format, input_format, options (e.g., quality, density). For "import/url": url, filename. For "export/url": no extra payload needed.
`name`	string	no	Optional name for the task (used to reference as input for subsequent tasks in a job).
`input`	string	no	Name of a previous task whose output this task should use as input.

`cloudconvert.cloudconvert_get_task`

Get details and status of a CloudConvert task by ID, including the result payload with download URLs for completed conversions.

Operation: Read read
Schema command: kosmo integrations:schema cloudconvert.cloudconvert_get_task --json

Parameter	Type	Required	Description
`task_id`	string	yes	The CloudConvert task ID.

`cloudconvert.cloudconvert_list_tasks`

List CloudConvert tasks with optional filtering by status, operation, or job ID, and pagination.

Operation: Read read
Schema command: kosmo integrations:schema cloudconvert.cloudconvert_list_tasks --json

Parameter	Type	Required	Description
`per_page`	integer	no	Number of tasks per page (default: 20, max: 100).
`page`	integer	no	Page number (default: 1).
`status`	string	no	Filter by status: waiting, processing, finished, error.
`operation`	string	no	Filter by operation type (e.g., "convert", "import/url").
`job_id`	string	no	Filter by job ID to list tasks for a specific job.

`cloudconvert.cloudconvert_get_current_user`

Get the authenticated CloudConvert user profile, including remaining credits and subscription info.

Operation: Read read
Schema command: kosmo integrations:schema cloudconvert.cloudconvert_get_current_user --json

Parameter	Type	Required	Description
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.