Batches

Execute a batch of assets through a workflow

Changed on

Start a new batch job to process multiple assets through a published workflow.

The request body supplies the workflow identifier and inputs: a list of runs, where each run is an array of node input mappings (node_id plus content and/or template).

Each run is processed separately through the workflow in parallel.

Returns a batchId and links that can be used to track progress and retrieve results.

post/batch/execute

Request

  • Base URL: https://run-workflow.adobe.io
  • URL: https://run-workflow.adobe.io/batch/execute
  • Auth: HTTP bearer and API key in header x-api-key

Headers

api-version'1.0'

Public API contract version for batch operations (/batch/…, GET /batches). The supported value is 1.0. If omitted, the service assumes 1.0. Unsupported values return 400 with status: "error".

x-gw-ims-org-idstring required

IMS organization ID for the authenticated caller. Scopes every request to that organization.

x-gw-ims-user-idstring required

IMS user ID for the authenticated caller.

Request body

Example request

{
  "workflow": {
    "workflowId": "121dc48a-f50b-427a-8aeb-f84c12c946a8",
    "inputs": [
      [
        {
          "node_id": "node_1775258981781_301b7cc7v_0_j5iaha",
          "content": [
            {
              "presignedUrl": "https://storage.example.com/bucket/asset.png?X-Amz-Algorithm=AWS4-HMAC-SHA256",
              "storageType": "AWS"
            }
          ]
        }
      ]
    ]
  }
}

Response

Accepted

batchIdstring required

Unique batch identifier.

workflowIdstring required

Identifier of the workflow associated with this batch.

status'pending' | 'running' | 'completed' | 'failed' | 'cancelled' required

Current batch status.

createdAtstring date-time required

Batch creation timestamp.

Example response

{
  "batchId": "batch-run-workflow_2402b5a2-bd2b-4309-a4a4-d7983bba64e9-20260403-750642eb",
  "workflowId": "run-workflow_2402b5a2-bd2b-4309-a4a4-d7983bba64e9"
}

Changes

  • db6f373f16f0Revision changes
    • breaking

      added the new required header request parameter x-gw-ims-org-id

    • breaking

      added the new required header request parameter x-gw-ims-user-id

    • info

      the endpoint scheme security BearerAuth AND ApiKeyAuth was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      added the non-success response with the status

  • 995d308ddc56Revision changes
    • breaking

      added the new required request property /

    • breaking

      added the new required request property /

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the request property

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new error enum value to the response property for the response status

    • warning

      added the new error enum value to the response property for the response status

    • warning

      added the new error enum value to the response property for the response status

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      api tag Batches added

    • info

      added the new optional header request parameter api-version

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property / to the response with the status