CloudConvert

Parámetros de entrada

• filestring

  Filename/path for the exported file in the bucket.

• inputstringObligatorio

  The ID of the task to export. Multiple task IDs can be provided as a list.

• bucketstringObligatorio

  The Google Cloud Storage bucket name.

• project_idstringObligatorio

  The Google Cloud Project ID (`api-project-...`).

• file_prefixstring

  Prefix for exported files in the bucket when exporting multiple files.

• private_keystringObligatorio

  The private key of the service account (PEM-encoded).

• client_emailstringObligatorio

  Service account client email (e.g., `my-sa@api-project-123456.iam.gserviceaccount.com`).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• aclstringenum

  S3 ACL for stored objects. Defaults to 'private'.

  privatepublic-readpublic-read-writeauthenticated-readbucket-owner-readbucket-owner-full-control
• keystring

  S3 object key (filename and path) for storing the file. Supports printf-style placeholders for multiple files, e.g., 'file-%d.pdf'.

• inputstringObligatorio

  The ID of the task to export, or a list of task IDs.

• bucketstringObligatorio

  The Amazon S3 bucket where to store the file(s).

• regionstringObligatorio

  S3 region identifier (e.g., 'us-west-2' or 'eu-west-1').

• taggingobject

  S3 object tags as key–value pairs.

• endpointstring

  Custom S3 API endpoint URL. Overrides default built from region. Use for S3-compatible services.

• metadataobject

  Additional S3 metadata as key–value pairs (e.g., 'x-amz-meta-*').

• key_prefixstring

  Prefix to prepend to the S3 object key when exporting multiple files.

• content_typestring

  Value for the 'Content-Type' header. Auto-detected if omitted.

• access_key_idstringObligatorio

  AWS access key ID with `s3:PutObject` permission.

• cache_controlstring

  Value for the 'Cache-Control' header (e.g., 'max-age=172800').

• session_tokenstring

  AWS session token for temporary (STS) credentials.

• secret_access_keystringObligatorio

  AWS secret access key.

• content_dispositionstring

  Value for the 'Content-Disposition' header (e.g., 'attachment' or 'inline').

• server_side_encryptionstringenum

  Server-side encryption algorithm to use (AES256 or aws:kms).

  AES256aws:kms

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• urlstringObligatoriouri

  The target URL to send webhook payloads to.

• eventstringObligatorio

  Event type to subscribe to (e.g., 'job.finished').

• payloadobject

  Custom payload object to include in each webhook call.

• signing_secretstring

  Secret to sign webhook payloads via HMAC-SHA256.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• webhook_idstringObligatorio

  UUID of the webhook to delete

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• includestring[]

  Include additional data: options and/or engine_versions.

• alternativesboolean

  Set to true to include alternative conversion types.

• filter[engine]string

  Filter to include only conversions with this engine name.

• filter[input_format]string

  Filter to include only conversions with this input format.

• filter[output_format]string

  Filter to include only conversions with this output format.

• filter[engine_version]string

  Filter to include only conversions with this engine version.

Parámetros de salida

• dataobject[]Obligatorio

  List of supported conversion types.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number to retrieve.

• statusstringenum

  Filter tasks by status.

  waitingprocessingfinishederror
• order_bystring

  Order the results by a column, e.g., 'created_at desc'.

• per_pageinteger

  Number of tasks per page.

• created_atstring

  Filter tasks by creation datetime (ISO 8601).

• completed_atstring

  Filter tasks by completion datetime (ISO 8601).

Parámetros de salida

• dataobject[]Obligatorio

  List of task objects.

• metaobjectObligatorio

  Pagination metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number to return (default: 1)

• per_pageinteger

  Number of webhooks per page (default: 100)

• filter[url]string

  Filter results to webhooks with this URL

Parámetros de salida

• dataobject[]Obligatorio

  List of webhooks

• metaobjectObligatorio

  Pagination metadata

• errorstring

  Error if any occurred during the execution of the action

• linksobjectObligatorio

  Pagination link URLs

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Current authenticated user details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not