CloudConvert integration: operations for AI agents
CloudConvert connects to Type.com as an integration. This page lists the 53 operations documented for Claude and Codex in Type.com: 9 read, 40 write, 4 destructive.
About CloudConvert
CloudConvert is a file conversion service supporting over 200 formats, including audio, video, document, ebook, archive, image, spreadsheet, and presentation formats.
Categories: Files & Storage
How to connect CloudConvert to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
53 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
53 operations listed.
jobs
- Read
Show job
Show a job status. This endpoint is asynchronous and immediately responds the job status, even if the job has not completed yet. There is also a synchronous version of this endpoint available. The Authorization header expects a Bearer token with the task.read scope. When set to true the response will a be a redirect to the export URL of the job. Using this parameter requires that the job has an export/url task. Documented parameters include redirect: When set to true the response will a be a redirect to the export URL of the job. Using this parameter requires that the job has an export/url task.; id: The ID of the job.; tag: Your given tag of the job.; status: The status of the job. Is one of waiting, processing, finished or error.; created_at: ISO8601 timestamp of the creation of the job.; started_at: ISO8601 timestamp when the job started processing..
GET /v2/jobs/{ID} - Read
Wait for job
Wait until the job status is completed and return the job status. This is the synchronous version of the show job endpoint. We do not recommend using this for long running jobs (e.g. video encodings). Your network stack might automatically time out requests if there is not data transferred for a longer time. As a good practice, please avoid to block your application until a CloudConvert job completes. There might be cases in which we need to queue your job which results in longer processing times than usual. Using an asynchronous approach with webhooks is beneficial in such cases. The Authorization header expects a Bearer token with the task.read scope. When set to true the response will a be a redirect to the export URL of the job. Using this parameter requires that the job has an export/url task. Documented parameters include redirect: When set to true the response will a be a redirect to the export URL of the job. Using this parameter requires that the job has an export/url task..
GET /v2/jobs/{ID} - Read
List jobs
List all your jobs. The Authorization header expects a Bearer token with the task.read scope. The result will be filtered to include only jobs with a specific status (processing, finished or error). The result will be filtered to include only jobs with a tag. Documented parameters include filter[status]: The result will be filtered to include only jobs with a specific status (processing, finished or error).; filter[tag]: The result will be filtered to include only jobs with a tag.; filter[access_token]: The result will be filtered to include only jobs created with a specific access token (API key) ID.; include: Include tasks in the result.; per_page: Number of tasks per page, defaults to 100, maximum 1000.; page: The result page to show..
GET /v2/jobs - Write
Create job
Create a job with one ore more tasks. This endpoint is asynchronous and immediately responds after job creation with a job in status processing. There is also a synchronous version of this endpoint available. The Authorization header expects a Bearer token with the task.write scope. The tasks of the job, which are typically an import task, a conversion task and an export task. The keys of the object are the names of the tasks. You can name these tasks however you want, but only alphanumeric characters, - and _ are allowed in the task names. A job can have up to 2000 tasks. Documented parameters include tasks: The tasks of the job, which are typically an import task, a conversion task and an export task. The keys of the object are the names of the tasks. You can name these tasks however you want, but only alphanumeric characters, - and _ are allowed in the task names. A job can have up to 2000 tasks. Each task has a operation, which is the endpoint for creating the task (for example: convert, import/s3 or export/s3).; input: The names of the input task for the task. Multiple task names can be provided as an array.; ignore_error: By default, the job fails if one task fails. You can ignore errors for specific tasks if you want to continue the job, even if one task fails.; ...: Task specific options. Depends on operation and the available options can be found in the documentation of the specific operation.; tag: An arbitrary string to identify the job. Does not have any effect and can be used to associate the job with an ID in your application.; webhook_url: A webhook that is used for this single job only. The url will receive a job.finished or job.failed event. We do recommend using account wide webhooks which can be created via the dashboard..
POST /v2/jobs - Write
Create job and wait
Create a job and block until the job is completed. This is the synchronous version of the create job endpoint. We do not recommend using this for long running jobs (e.g. video encodings). Your network stack might automatically time out requests if there is not data transferred for a longer time. As a good practice, please avoid to block your application until a CloudConvert job completes. There might be cases in which we need to queue your job which results in longer processing times than usual. Using an asynchronous approach with webhooks is beneficial in such cases. The Authorization header expects a Bearer token with the task.write scope. The tasks of the job, which are typically an import task, a conversion task and an export task. The keys of the object are the names of the tasks. You can name these tasks however you want, but only alphanumeric characters, - and _ are allowed in the task names. A job can have up to 2000 tasks. Documented parameters include tasks: The tasks of the job, which are typically an import task, a conversion task and an export task. The keys of the object are the names of the tasks. You can name these tasks however you want, but only alphanumeric characters, - and _ are allowed in the task names. A job can have up to 2000 tasks. Each task has a operation, which is the endpoint for creating the task (for example: convert, import/s3 or export/s3).; input: The names of the input task for the task. Multiple task names can be provided as an array.; ignore_error: By default, the job fails if one task fails. You can ignore errors for specific tasks if you want to continue the job, even if one task fails.; ...: Task specific options. Depends on operation and are the same as for creating the task using their direct endpoint.; tag: An arbitrary string to identify the job. Does not have any effect and can be used to associate the job with an ID in your application.; redirect: When set to true the response will a be a redirect to the export URL of the job. Using this parameter requires that the job has an export/url task..
POST /v2/jobs - Destructive
Delete job
Delete a job, including all tasks and data. Requires the task.write scope. Jobs are deleted automatically 24 hours after they have ended. The Authorization header expects a Bearer token with the task.write scope. An empty response with HTTP Code 204.
DELETE /v2/jobs/{ID}
tasks
- Read
Show task
Show a task status. This endpoint is asynchronous and immediately responds the task status, even if the task has not completed yet. There is also a synchronous version of this endpoint available. The Authorization header expects a Bearer token with the task.read scope. Include retries, depends_on_tasks, payload and/or job in the result. Multiple include values are separated by ,. Documented parameters include include: Include retries, depends_on_tasks, payload and/or job in the result. Multiple include values are separated by ,.; id: The ID of the task.; job_id: The Job ID the task belongs to.; name: The name of the task. Only available if the task is part of a job.; operation: Name of the operation, for example convert or import/s3.; status: The status of the task. Is one of waiting, processing, finished or error..
GET /v2/tasks/{ID} - Read
Wait for task
Wait until the task status is completed and return the task status. This is the synchronous version of the show task endpoint. We do not recommend using this for long running tasks (e.g. video encodings). Your network stack might automatically time out requests if there is not data transferred for a longer time. As a good practice, please avoid to block your application until a CloudConvert task completes. There might be cases in which we need to queue your task which results in longer processing times than usual. Using an asynchronous approach with webhooks is beneficial in such cases. The Authorization header expects a Bearer token with the task.read scope. The finished or failed task. You can find details about the task model response in the documentation about the show task endpoint.
GET /v2/tasks/{ID} - Read
List tasks
List all your tasks with their status, payload and result. The Authorization header expects a Bearer token with the task.read scope. The result will be filtered to include only tasks for a specific Job ID. The result will be filtered to include only tasks with a specific status (waiting, processing, finished or error). Documented parameters include filter[job_id]: The result will be filtered to include only tasks for a specific Job ID.; filter[status]: The result will be filtered to include only tasks with a specific status (waiting, processing, finished or error).; filter[operation]: Filter result to only include tasks with a matching operation (for example convert or import/s3).; include: Include retries and/or depends_on_tasks in the result.; per_page: Number of tasks per page, defaults to 100, maximum 1000.; page: The result page to show..
GET /v2/tasks - Write
Retry task
Create a new task, based on the payload of another task. The Authorization header expects a Bearer token with the task.write scope. The new task (with a new task ID). You can find details about the task model response in the documentation about the show task endpoint.
POST /v2/tasks/{ID}/retry - Destructive
Cancel task
Cancel a task that is in status waiting or processing. The Authorization header expects a Bearer token with the task.write scope. The updated task. You can find details about the task model response in the documentation about the show task endpoint.
POST /v2/tasks/{ID}/cancel - Destructive
Delete task
Delete a task, including all data. Tasks are deleted automatically 24 hours after they have ended. The Authorization header expects a Bearer token with the task.write scope. An empty response with HTTP Code 204.
DELETE /v2/tasks/{ID}
operations
- Read
List operations
List all possible operations, formats, engines and possible options. The result will be filtered to include only possible operations with a matching operation name (e.g. convert or optimize). The result will be filtered to include only possible conversions with a matching input format. The result will be filtered to include only possible conversions with a matching output format. Documented parameters include filter[operation]: The result will be filtered to include only possible operations with a matching operation name (e.g. convert or optimize).; filter[input_format]: The result will be filtered to include only possible conversions with a matching input format.; filter[output_format]: The result will be filtered to include only possible conversions with a matching output format.; filter[engine]: Filter result to only include conversions with a matching engine name.; filter[engine_version]: Filter result to only include conversions with a matching engine version.; alternatives: For some formats multiple alternative engines are available. If set to true, the result includes these alternative conversion types. Defaults to false..
GET /v2/operations
users
- Read
Show user
Show the current user. The Authorization header expects a Bearer token with the user.read scope. The current user: The ID of the user. Documented parameters include id: The ID of the user.; username: The username of the user.; email: The email address of the user.; credits: Remaining conversion credits.; created_at: ISO8601 timestamp when the user was created..
GET /v2/users/me - Read
List webhooks
List all webhooks. The Authorization header expects a Bearer token with the webhook.read scope. The result will be filtered to include only webhooks with a specific URL. Number of webhooks per page, defaults to 100, maximum 1000. Documented parameters include filter[url]: The result will be filtered to include only webhooks with a specific URL.; per_page: Number of webhooks per page, defaults to 100, maximum 1000.; page: The result page to show..
GET /v2/users/me/webhooks
webhooks
- Write
Create webhook
Create a webhook via API. The Authorization header expects a Bearer token with the webhook.write scope. The URL to send the notifications to. Select the events. See the available events here. Documented parameters include url: The URL to send the notifications to.; events: Select the events. See the available events here.; id: The ID of the webhook.; url: The URL of the webhook.; disabled: Whether the webhook is disabled.; events: The events the webhook is subscribed to..
POST /v2/webhooks - Destructive
Delete webhook
Delete a webhook. The Authorization header expects a Bearer token with the webhook.write scope. An empty response with HTTP Code 204.
DELETE /v2/webhooks/{ID}
Job task payloads
- Write
Create convert task in a job
Creates a job task with operation=convert. Documented options: operation _string_ required: Value is convert.; input _string or array of task names_: The input task name(s) for this task.; input_format _string_: The current format of the file, e.g. pdf. If not set, the extension of the input file is used as input format.; output_format _string_ required: The target format to convert to.; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours.; ... _string_: Conversion specific options depend on the input and output format. Select input and output format above to show additional conversion options..
POST /v2/jobs - Write
Create optimize task in a job
Creates a job task with operation=optimize. Documented options: operation _string_ required: Value is optimize.; input _string or array of task names_: The input task name(s) for this task.; input_format _string_: The current format of the file, e.g. pdf. If not set, the extension of the input file is used as input format.; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create watermark task in a job
Creates a job task with operation=watermark. Documented options: operation _string_ required: Value is watermark.; input _string or array of task names_: Files to add the watermark to; input_format _string_: The current format of the file, e.g. pdf. If not set, the extension of the input file is used as input format.; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create capture-website task in a job
Creates a job task with operation=capture-website. Documented options: operation _string_ required: Value is capture-website.; url _string_ required: URL of the website; output_format _string_ required: The target format to convert to.; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create thumbnail task in a job
Creates a job task with operation=thumbnail. Documented options: operation _string_ required: Value is thumbnail.; input _string or array of task names_: The input task name(s) for this task.; input_format _string_: The current format of the file, e.g. pdf. If not set, the extension of the input file is used as input format.; output_format _string_ required: The target format to convert to.; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create merge task in a job
Creates a job task with operation=merge. Documented options: operation _string_ required: Value is merge.; input _string or array of task names_: The input task name(s) for this task.; output_format _string_ required: The target format to convert to.; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create pdf/a task in a job
Creates a job task with operation=pdf/a. Documented options: operation _string_ required: Value is pdf/a.; input _string or array of task names_ required: Files to perform the operation on; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create pdf/x task in a job
Creates a job task with operation=pdf/x. Documented options: operation _string_ required: Value is pdf/x.; input _string or array of task names_ required: Files to perform the operation on; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create pdf/ocr task in a job
Creates a job task with operation=pdf/ocr. Documented options: operation _string_ required: Value is pdf/ocr.; input _string or array of task names_ required: Files to perform the operation on; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create pdf/encrypt task in a job
Creates a job task with operation=pdf/encrypt. Documented options: operation _string_ required: Value is pdf/encrypt.; input _string or array of task names_ required: Files to perform the operation on; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create pdf/decrypt task in a job
Creates a job task with operation=pdf/decrypt. Documented options: operation _string_ required: Value is pdf/decrypt.; input _string or array of task names_ required: Files to perform the operation on; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create pdf/split-pages task in a job
Creates a job task with operation=pdf/split-pages. Documented options: operation _string_ required: Value is pdf/split-pages.; input _string or array of task names_ required: Files to perform the operation on; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create pdf/extract-pages task in a job
Creates a job task with operation=pdf/extract-pages. Documented options: operation _string_ required: Value is pdf/extract-pages.; input _string or array of task names_ required: Files to perform the operation on; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create pdf/rotate-pages task in a job
Creates a job task with operation=pdf/rotate-pages. Documented options: operation _string_ required: Value is pdf/rotate-pages.; input _string or array of task names_ required: Files to perform the operation on; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create archive task in a job
Creates a job task with operation=archive. Documented options: operation _string_ required: Value is archive.; input _string or array of task names_: The input task name(s) for this task.; output_format _string_ required: The archive format.; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create archive/extract task in a job
Creates a job task with operation=archive/extract. Documented options: operation _string_ required: Value is archive/extract.; input _string or array of task names_: The input task name(s) for this task.; input_format _string_: The format of the archive, e.g. zip. If not set, the extension of the input file is used as input format.; engine _string_: Use a specific engine for the extraction.; engine_version _string_: Use a specific engine version for the extraction.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create metadata task in a job
Creates a job task with operation=metadata. Documented options: operation _string_ required: Value is metadata.; input _string or array of task names_: The input task name(s) for this task.; input_format _string_: The current format of the file, e.g. pdf. If not set, the extension of the input file is used as input format.; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create metadata/write task in a job
Creates a job task with operation=metadata/write. Documented options: operation _string_ required: Value is metadata/write.; input _string or array of task names_: The input task name(s) for this task.; input_format _string_: The current format of the file, e.g. pdf. If not set, the extension of the input file is used as input format.; engine _string_: Use a specific engine for the conversion.; engine_version _string_: Use a specific engine version for the conversion.; metadata _dictionary_ required: Object of metadata to write.; filename _string_: Choose a filename (including extension) for the output file.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create command task in a job
Creates a job task with operation=command. Documented options: operation _string_ required: Value is command.; input _string or array of task names_: The input task name(s) for this task.; engine _string_ required: The engine to use for the command.; engine_version _string_: Use a specific engine version for the conversion.; capture_output _boolean_: Capture the console output of the command and return it in the results object.; timeout _integer_: Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours..
POST /v2/jobs - Write
Create ai/agent task in a job
Creates a job task with operation=ai/agent. Documented options: operation _string_ required: Value is ai/agent.; input _string or array of task names_: The input task name(s) for this task.; prompt _string_ required: What the agent should do with the input files. The agent creates the required tasks in this job.; engine _string_: The AI model the agent uses. If not set, the default model is used.; timeout _integer_: Timeout in seconds after the task will be cancelled..
POST /v2/jobs - Write
Create import/url task in a job
Creates a job task with operation=import/url. Documented options: operation _string_ required: Value is import/url.; url _string_ required: The URL to the file.; filename _string_ required: The filename of the input file, including extension. If none provided we will try to detect the filename from the URL.; headers _dictionary_: Object of additional headers to send with the download request. Can be used to access URLs that require authorization..
POST /v2/jobs - Write
Create import/base64 task in a job
Creates a job task with operation=import/base64. Documented options: operation _string_ required: Value is import/base64.; file _string_ required: Base64 encoded file content.; filename _string_ required: The filename of the input file, including extension..
POST /v2/jobs - Write
Create import/raw task in a job
Creates a job task with operation=import/raw. Documented options: operation _string_ required: Value is import/raw.; file _string_ required: File content as string.; filename _string_ required: The filename of the input file, including extension..
POST /v2/jobs - Write
Create import/s3 task in a job
Creates a job task with operation=import/s3. Documented options: operation _string_ required: Value is import/s3.; bucket _string_ required: The Amazon S3 bucket where to download the file.; region _string_ required: Specify the Amazon S3 endpoint, e.g. us-west-2 or eu-west-1.; endpoint _string_: Use a custom S3 API endpoint. The default endpoint is built from the configured region. Makes it possible to use other S3 compatible storage services (e.g. DigitalOcean).; key _string_: S3 key of the input file (the filename in the bucket, including path).; key_prefix _string_: Alternatively to using key, you can specify a key prefix for importing multiple files at once.; access_key_id _string_ required: The Amazon S3 access key id. It needs to have the s3:GetObject permission.; secret_access_key _string_ required: The Amazon S3 secret access key.; session_token _string_: Auth using temporary credentials (AWS Security Token Service)..
POST /v2/jobs - Write
Create import/azure/blob task in a job
Creates a job task with operation=import/azure/blob. Documented options: operation _string_ required: Value is import/azure/blob.; storage_account _string_ required: The name of the Azure storage account (This is the string before .blob.core.windows.net).; storage_access_key _string_: The Azure secret key. Only required alternatively, if you are not providing a SAS token.; sas_token _string_: The Azure SAS token.; container _string_ required: Azure container name.; blob _string_: Azure blob name of the input file (the filename in the bucket, including path).; blob_prefix _string_: Alternatively to using blob, you can specify a blob prefix for importing multiple files at once..
POST /v2/jobs - Write
Create import/google-cloud-storage task in a job
Creates a job task with operation=import/google-cloud-storage. Documented options: operation _string_ required: Value is import/google-cloud-storage.; project_id _string_ required: The Google Cloud Project ID (api-project-...).; bucket _string_ required: The Google Cloud Storage Bucket name.; client_email _string_ required: The client email of the service account to use (...@api-project-....iam.gserviceaccount.com).; private_key _string_ required: The private key of the service account.; file _string_: Filename of the input file (the filename in the bucket, including path).; file_prefix _string_: Alternatively to using file, you can specify a file prefix for importing multiple files at once..
POST /v2/jobs - Write
Create import/openstack task in a job
Creates a job task with operation=import/openstack. Documented options: operation _string_ required: Value is import/openstack.; auth_url _string_ required: The URL of the OpenStack Identity endpoint (without version).; region _string_ required: Specify the OpenStack region.; container _string_ required: The name of the OpenStack Storage container.; username _string_ required: The OpenStack username.; password _string_ required: The OpenStack password.; file _string_: File name of the input file (the filename in the container, including path).; file_prefix _string_: Alternatively to using file, you can specify a file prefix for importing multiple files at once..
POST /v2/jobs - Write
Create import/sftp task in a job
Creates a job task with operation=import/sftp. Documented options: operation _string_ required: Value is import/sftp.; host _string_ required: The SFTP server hostname.; port _integer_: The SFTP port. Defaults to 22.; username _string_ required: The SFTP username.; password _string_: The SFTP password.; private_key _string_: Alternatively to using password, you can provide a private key.; file _string_: File name of the input file (the filename on the server, including path).; path _string_: Alternatively to using file, you can specify a path for importing multiple files at once..
POST /v2/jobs - Write
Create export/url task in a job
Creates a job task with operation=export/url. Documented options: operation _string_ required: Value is export/url.; input _string or array of task names_: The input task name(s) for this task.; inline _boolean_: This option makes the export URLs return the Content-Disposition inline header, which tells browser to display the file instead of downloading it.; archive_multiple_files _boolean_: By default, multiple files will create multiple export URLs. When enabling this option, one export URL with a ZIP file will be created..
POST /v2/jobs - Write
Create export/s3 task in a job
Creates a job task with operation=export/s3. Documented options: operation _string_ required: Value is export/s3.; input _string or array of task names_: The input task name(s) for this task.; bucket _string_ required: The Amazon S3 bucket where to store the file(s).; region _string_ required: Specify the Amazon S3 endpoint, e.g. us-west-2 or eu-west-1.; endpoint _string_: Use a custom S3 API endpoint. The default endpoint is built from the configured region. Makes it possible to use other S3 compatible storage services (e.g. DigitalOcean).; key _string_: S3 key for storing the file (the filename in the bucket, including path). If there are multiple files to export, printf style placeholders are possible (e.g. myfile-%d.pdf produces the output files myfile-1.pdf, myfile-2.pdf and so on).; key_prefix _string_: Alternatively to using key, you can specify a key prefix for exporting files.; access_key_id _string_ required: The Amazon S3 access key id. It needs to have the s3:PutObject permission. When using a different ACL from private, it needs to have the s3:PutObjectAcl permission.; secret_access_key _string_ required: The Amazon S3 secret access key.; session_token _string_: Auth using temporary credentials (AWS Security Token Service).; acl _string_: S3 ACL for storing the files. Possible values include: private, public-read, public-read-write, authenticated-read, bucket-owner-read, bucket-owner-full-control. Defaults to private.; cache_control _string_: S3 CacheControl header to specify the lifetime of the file, for example: max-age=172800.; content_disposition _string_: Specify the Content-Disposition header for the file, for example: attachment or inline.; content_type _string_: Specify the Content-Type header for the file, for example: application/pdf. By default, it will automatically set the correct Content-Type based on the mime type.; metadata _dictionary_: Object of additional S3 meta data.; server_side_encryption _string_: Enable the Server-side encryption algorithm used when storing this object in S3. Possible values include AES256 and aws:kms.; tagging _dictionary_: Object of S3 tags to add to the keys..
POST /v2/jobs - Write
Create export/azure/blob task in a job
Creates a job task with operation=export/azure/blob. Documented options: operation _string_ required: Value is export/azure/blob.; input _string or array of task names_: The input task name(s) for this task.; storage_account _string_ required: The name of the Azure storage account (This is the string before .blob.core.windows.net).; storage_access_key _string_: The Azure secret key. Only required alternatively, if you are not providing a SAS token.; sas_token _string_: The SAS token for the Azure storage account.; container _string_ required: Azure container name.; blob _string_: Blob name for storing the file (the filename in the container, including path). If there are multiple files to export, printf style placeholders are possible (e.g. myfile-%d.pdf produces the output files myfile-1.pdf, myfile-2.pdf and so on).; blob_prefix _string_: Alternatively to using blob, you can specify a blob prefix for exporting files.; metadata _dictionary_: Object of additional Azure meta data..
POST /v2/jobs - Write
Create export/google-cloud-storage task in a job
Creates a job task with operation=export/google-cloud-storage. Documented options: operation _string_ required: Value is export/google-cloud-storage.; input _string or array of task names_: The input task name(s) for this task.; project_id _string_ required: The Google Cloud Project ID (api-project-...).; bucket _string_ required: The Google Cloud Storage Bucket name.; client_email _string_ required: The client email of the service account to use (...@api-project-....iam.gserviceaccount.com).; private_key _string_ required: The private key of the service account.; file _string_: Filename of the file to create (the filename in the bucket, including path).; file_prefix _string_: Alternatively to using file, you can specify a file prefix for exporting files..
POST /v2/jobs - Write
Create export/openstack task in a job
Creates a job task with operation=export/openstack. Documented options: operation _string_ required: Value is export/openstack.; input _string or array of task names_: The input task name(s) for this task.; auth_url _string_ required: The URL of the OpenStack Identity endpoint (without version).; region _string_ required: Specify the OpenStack region.; container _string_ required: The name of the OpenStack Storage container.; username _string_ required: The OpenStack username.; password _string_ required: The OpenStack password.; file _string_: File name of the file to create (the filename in container bucket, including path).; file_prefix _string_: Alternatively to using file, you can specify a file prefix for exporting files..
POST /v2/jobs - Write
Create export/sftp task in a job
Creates a job task with operation=export/sftp. Documented options: operation _string_ required: Value is export/sftp.; input _string or array of task names_: The input task name(s) for this task.; host _string_ required: The SFTP server hostname.; port _integer_: The SFTP port. Defaults to 22.; username _string_ required: The SFTP username.; password _string_: The SFTP password.; private_key _string_: Alternatively to using password, you can provide a private key.; file _string_: File name of the file to create (the filename on the server, including path).; path _string_: Alternatively to using file, you can specify a path for exporting files..
POST /v2/jobs - Write
Create export/upload task in a job
Creates a job task with operation=export/upload. Documented options: operation _string_ required: Value is export/upload.; input _string or array of task names_: The input task name(s) for this task.; url _string_ required: The URL to send the PUT request to.; headers _dictionary_: Object of additional headers to send with the PUT request. Can be used to access URLs that require authorization..
POST /v2/jobs - Write
Create import/upload task in a job
Creates a job task with operation=import/upload. Documented options: operation (string, required): import/upload; redirect: Optionally redirect user to this URL after upload..
POST /v2/jobs
No operations match.
See How connections work for access and permissions, or browse all integrations.