Adobe Suite Batches API

Batches allow users to understand which operations and applications have been performed on objects tracked by the system.

Operations 12

GET /batches Retrieve a list of batches #
POST /batches Create a new batch #
GET /batches/uniques/{FIELD} Look up the unique values stored in a field #
GET /batches/{BATCH_ID} Look up a batch #
PUT /batches/{BATCH_ID} Update a batch #
POST /batches/{BATCH_ID} Create a new batch #
DELETE /batches/{BATCH_ID} Delete a batch #
PATCH /batches/{BATCH_ID} Update one or more batch attributes #
POST /batch/execute Execute a batch of assets through a workflow #
GET /batch/{batchId}/status Get batch status #
POST /batch/{batchId}/cancel Cancel a batch #
GET /batch/{batchId}/executions List individual execution results #

Documentation

📖
Documentation
https://developer.adobe.com/photoshop/api/docs/
📖
Authentication
https://developer.adobe.com/developer-console/docs/guides/authentication/
📖
Documentation
https://developer.adobe.com/lightroom/api/docs/
📖
Documentation
https://developer.adobe.com/illustrator/api/docs/
📖
Documentation
https://developer.adobe.com/indesign/docs/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/
📖
GettingStarted
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/gettingstarted/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-accessibility-auto-tag-api/
📖
Documentation
https://developer.adobe.com/analytics-apis/docs/
📖
APIReference
https://developer.adobe.com/analytics-apis/docs/2.0/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/
📖
APIReference
https://developer.adobe.com/firefly-services/docs/api/
📖
Documentation
https://developer.adobe.com/audio-video-firefly-services/
📖
GettingStarted
https://developer.adobe.com/audio-video-firefly-services/getting-started/
📖
Documentation
https://developer.adobe.com/creative-cloud-libraries/docs/
📖
APIReference
https://developer.adobe.com/creative-cloud-libraries/docs/api/
📖
Documentation
https://developer.adobe.com/express/embed-sdk/docs/guides/
📖
APIReference
https://developer.adobe.com/express/embed-sdk/docs/v4/
📖
GettingStarted
https://developer.adobe.com/express/embed-sdk/docs/guides/quickstart/
📖
Documentation
https://developer.adobe.com/experience-platform-apis/
📖
GettingStarted
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-guide
📖
Documentation
https://developer.adobe.com/marketo-apis/
📖
Authentication
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/authentication
📖
Documentation
https://developer.adobe.com/commerce/docs/
📖
GettingStarted
https://developer.adobe.com/commerce/webapi/get-started/
📖
Documentation
https://developer.adobe.com/experience-cloud/cloud-manager/
📖
Documentation
https://developer.adobe.com/journey-optimizer-apis/
📖
Documentation
https://developer.adobe.com/workfront-apis/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/substance3d/
📖
Documentation
https://developer.adobe.com/data-collection-apis/
📖
Documentation
https://developer.adobe.com/adobe-status/
📖
Documentation
https://developer.adobe.com/vip-marketplace/

Specifications

Other Resources

🔗
Pricing
https://developer.adobe.com/document-services/pricing/
🔗
SDKs
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/sdks/
🔗
ReleaseNotes
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/releasenotes
🔗
Guides
https://developer.adobe.com/analytics-apis/docs/2.0/guides/
🔗
Guides
https://developer.adobe.com/firefly-services/docs/guides/
🔗
Usage Notes
https://developer.adobe.com/audio-video-firefly-services/getting_started/usage/
🔗
Overview
https://developer.adobe.com/creative-cloud-libraries/docs/overview/
🔗
Integration Guide
https://developer.adobe.com/creative-cloud-libraries/docs/integrate/
🔗
API Fundamentals
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-fundamentals
🔗
Developer Guide
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home
🔗
REST API
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/rest-api
🔗
REST API
https://developer.adobe.com/commerce/webapi/rest/
🔗
GraphQL API
https://developer.adobe.com/commerce/webapi/graphql-api/
🔗
REST API Reference
https://developer.adobe.com/commerce/webapi/reference/rest/paas/
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/graphql/adobe-suite-graphql.md
🔗
Webhooks
https://developer.adobe.com/experience-cloud/cloud-manager/guides/getting-started/create-event-integration/
🔗
StatusPage
https://status.adobe.com/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/adobe-suite-batches-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

adobe-suite-batches-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Adobe Suite Batches API
  version: '1.0'
  description: 'Operations tagged Batches across 2 of this provider''s published API definitions: adobe-suite-aep-catalog-openapi.yaml, adobe-suite-firefly-workflow-builder-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: //{environment}.adobe.io/data/foundation/catalog
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
- url: https://run-workflow.adobe.io
  description: Production
tags:
- name: Batches
  description: Batches allow users to understand which operations and applications have been performed on objects tracked by the system.
paths:
  /batches:
    get:
      tags:
      - Batches
      summary: Retrieve a list of batches
      description: This request retrieves a list of batches for operations and applications that have been performed on objects tracked by the system.
      operationId: listBatches
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      - $ref: '#/components/parameters/limit'
      - name: createdAfter
        in: query
        description: Exclusively filter records created after this timestamp.
        schema:
          type: integer
          format: int64
      - name: createdBefore
        in: query
        description: Exclusively filter records created before this timestamp.
        schema:
          type: integer
          format: int64
      - name: created
        in: query
        description: Filter by the Unix timestamp (in milliseconds) when this object was persisted.
        schema:
          type: integer
          format: int64
      - name: createdClient
        in: query
        description: Filter by the ID of the IMS client that created this object.
        schema:
          type: string
      - name: updated
        in: query
        description: Filter by the Unix timestamp (in milliseconds) for the time of last modification.
        schema:
          type: integer
          format: int64
      - name: createdUser
        in: query
        description: Filter by the ID of the user who created this object.
        schema:
          type: string
      - name: updatedUser
        in: query
        description: Filter by the ID of the user who changed this object.
        schema:
          type: string
      - name: version
        in: query
        description: Filter by Semantic version of the account. Updated when the object is modified.
        schema:
          type: string
      - name: tags
        in: query
        description: Filter response by the specified tags.
        schema:
          type: string
      - name: status
        in: query
        description: Filter by the current (mutable) status of the batch.
        schema:
          type: string
      - name: recordCount
        in: query
        description: Filter by the total number of data records (rows or documents) processed in the batch.
        schema:
          type: integer
          format: int64
      - name: failedRecordCount
        in: query
        description: Filter by the number of records that could **not** be processed in the batch.
        schema:
          type: integer
          format: int64
      - name: size
        in: query
        description: The number of bytes processed in the batch.
        schema:
          type: integer
          format: int64
      - name: started
        in: query
        description: Filter by the Unix timestamp (in milliseconds) when the batch processing action was started. Subtracting "started" from "completed" will yield the total processing time.
        schema:
          type: integer
          format: int64
      - name: completed
        in: query
        description: Filter by the Unix timestamp (in milliseconds) when the batch processing action was completed. Subtracting "started" from "completed" will yield the total processing time.
        schema:
          type: integer
          format: int64
      - name: startAfter
        in: query
        description: Filter for batches with availability dates that start after the specified timestamp.
        schema:
          type: integer
          format: int64
      - name: startBefore
        in: query
        description: Filter for batches with availability dates that start before the specified timestamp.
        schema:
          type: integer
          format: int64
      - name: endAfter
        in: query
        description: Filter for batches with availability dates that end after the specified timestamp.
        schema:
          type: integer
          format: int64
      - name: endBefore
        in: query
        description: Filter for batches with availability dates that end before the specified timestamp.
        schema:
          type: integer
          format: int64
      - name: batch
        in: query
        description: Filter on the ID of the batch.
        schema:
          type: string
      - name: externalId
        in: query
        description: Filter on the ID of the external object.
        schema:
          type: string
      - name: dataSet
        in: query
        description: Filter on the ID of the dataset.
        schema:
          type: string
      - name: orderBy
        in: query
        description: Sort parameter and direction for sorting the response. Ex. orderBy=asc:created,updated. This was previously called sort.
        schema:
          type: string
      - name: start
        in: query
        description: Specifies the offset of the pages of results. To get the first page of results, set the value to `start=0`.
        schema:
          type: integer
          default: 0
      - name: property
        in: query
        description: Regex used to filter objects in the response.
        schema:
          type: string
      - name: properties
        in: query
        description: A comma separated allowlist of top-level object properties to be returned in the response. Used to cut down the number of properties and amount of data returned in the response bodies.
        schema:
          type: string
      responses:
        200:
          description: A list of the batch responses is returned.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/batchResponse'
              example:
                5911f88ae2f4bf657c5a8cb5:
                  imsOrg: 4F3BB22C5631222A7F000101@AdobeOrg
                  created: 1494349962314
                  createdClient: MCDPCatalogServiceStage
                  createdUser: MCDPCatalogServiceStage@AdobeID
                  updatedUser: MCDPCatalogServiceStage@AdobeID
                  updated: 1494349963467
                  externalId: /adobe/bulkingest/5af9ee67e4045c1b4945c209
                  status: success
                  errors:
                  - code: err-1494349963436
                  version: 1.0.3
                  availableDates:
                    startDate: 1337
                    endDate: 4000
                  relatedObjects:
                  - type: batch
                    id: foo_batch
                  - type: dataSet
                    id: foo_dataSet
                  - type: dataSetView
                    id: foo_dataSetView
                  - type: dataSetFile
                    id: foo_dataSetFile
                  - type: expressionBlock
                    id: foo_expressionBlock
                  - type: service
                    id: foo_service
                  - type: serviceDefinition
                    id: foo_serviceDefinition
                  metrics:
                    foo: 1337
                  tags:
                    foo_bar:
                    - stuff
                    bar_foo:
                    - woo
                    - baz
                    foo/bar/foo-bar:
                    - weehaw
                    - wee:haw
                  inputFormat:
                    format: parquet
                    delimiter: .
                    quote: '`'
                    escape: \
                    nullMarker: ''
                    header: 'true'
                    charset: UTF-8
        400:
          description: A bad request.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        404:
          description: The batch responses were not found.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
    post:
      tags:
      - Batches
      summary: Create a new batch
      description: This request creates a new batch for operations and applications that have been performed on objects tracked by the system.
      operationId: createBatch
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: The batch that will be created.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/batchRequest'
        required: true
      responses:
        201:
          description: Array[ @/batches/batchId ]
          headers:
            Location:
              description: The URI of the newly created batch.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        400:
          description: The batch is invalid.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
      x-codegen-request-body-name: batch
    servers:
    - url: //{environment}.adobe.io/data/foundation/catalog
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /batches/uniques/{FIELD}:
    get:
      tags:
      - Batches
      summary: Look up the unique values stored in a field
      description: This endpoint retrieves the unique values stored in a field, as specified by the ID.
      operationId: retrieveUniqueBatchValues
      parameters:
      - name: FIELD
        in: path
        description: 'Field to get unique values for. **Note:** This endpoint will be deprecated soon. '
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      - $ref: '#/components/parameters/limit'
      - name: createdAfter
        in: query
        description: Exclusively filter records created after this timestamp.
        schema:
          type: integer
          format: int64
      - name: createdBefore
        in: query
        description: Exclusively filter records created before this timestamp.
        schema:
          type: integer
          format: int64
      - name: created
        in: query
        description: Filter by the Unix timestamp (in milliseconds) when this object was persisted.
        schema:
          type: integer
          format: int64
      - name: createdClient
        in: query
        description: Filter by the ID of the IMS client that created this object.
        schema:
          type: string
      - name: updated
        in: query
        description: Filter by the Unix timestamp (in milliseconds) for the time of last modification.
        schema:
          type: integer
          format: int64
      - name: createdUser
        in: query
        description: Filter by the ID of the user who created this object.
        schema:
          type: string
      - name: updatedUser
        in: query
        description: Filter by the ID of the user who changed this object.
        schema:
          type: string
      - name: version
        in: query
        description: Filter by Semantic version of the account. Updated when the object is modified.
        schema:
          type: string
      - name: status
        in: query
        description: Filter by the current (mutable) status of the batch.
        schema:
          type: string
      - name: recordCount
        in: query
        description: Filter by the total number of data records (rows or documents) processed in the batch. 100 objects is the maximum that can be returned by requests.
        schema:
          type: integer
          format: int64
      - name: failedRecordCount
        in: query
        description: Filter by the number of records that could **not** be processed in the batch.
        schema:
          type: integer
          format: int64
      - name: size
        in: query
        description: The number of bytes processed in the batch.
        schema:
          type: integer
          format: int64
      - name: started
        in: query
        description: Filter by the Unix timestamp (in milliseconds) when the batch processing action was started. Subtracting "started" from "completed" will yield the total processing time.
        schema:
          type: integer
          format: int64
      - name: completed
        in: query
        description: Filter by the Unix timestamp (in milliseconds) when the batch processing action was completed. Subtracting "started" from "completed" will yield the total processing time.
        schema:
          type: integer
          format: int64
      - name: startAfter
        in: query
        description: Filter for batches with availability dates that start after the specified timestamp.
        schema:
          type: integer
          format: int64
      - name: startBefore
        in: query
        description: Filter for batches with availability dates that start before the specified timestamp.
        schema:
          type: integer
          format: int64
      - name: endAfter
        in: query
        description: Filter for batches with availability dates that end after the specified timestamp.
        schema:
          type: integer
          format: int64
      - name: endBefore
        in: query
        description: Filter for batches with availability dates that end before the specified timestamp.
        schema:
          type: integer
          format: int64
      - name: batch
        in: query
        description: Filter on the ID of the batch.
        schema:
          type: string
      - name: externalId
        in: query
        description: Filter on the ID of the external object.
        schema:
          type: string
      - name: dataSet
        in: query
        description: Filter on the ID of the dataset.
        schema:
          type: string
      - name: transform
        in: query
        description: Filter on the ID of the transform.
        schema:
          type: string
      - name: orderBy
        in: query
        description: Sort parameter and direction for sorting the response. Ex. orderBy=asc:created,updated. This was previously called sort.
        schema:
          type: string
      - name: start
        in: query
        description: Specifies the offset of the pages of results. To get the first page of results, set the value to `start=0`.
        schema:
          type: integer
          default: 0
      - name: property
        in: query
        description: Regex used to filter objects in the response.
        schema:
          type: string
      - name: properties
        in: query
        description: A comma separated allowlist of top-level object properties to be returned in the response. Used to cut down the number of properties and amount of data returned in the response bodies.
        schema:
          type: string
      responses:
        200:
          description: A list of unique values for a batch.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
              example:
              - 5911f88ae2f4bf657c5a8cb5
              - 5911f88ae2f4bf657c5a8cb4
              - 5911f88ae2f4bf657c5a8cb3
        400:
          description: A bad request has been submitted.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        404:
          description: The batch is not found.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
    servers:
    - url: //{environment}.adobe.io/data/foundation/catalog
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /batches/{BATCH_ID}:
    get:
      tags:
      - Batches
      summary: Look up a batch
      description: This request retrieves a specific batch based on the {BATCH_ID} entered.
      operationId: retrieveBatch
      parameters:
      - name: BATCH_ID
        in: path
        description: The ID of the batch you are performing the operation on.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      - name: aggregate
        in: query
        description: If true, then return the aggregated status, metrics, and errors in the root level status, metrics, and errors (default is false).
        schema:
          type: boolean
      responses:
        200:
          description: The batch object for the specified batch ID is returned.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/batchResponse'
              example:
                5911f88ae2f4bf657c5a8cb5:
                  imsOrg: 5911f88ae2f4bf657c5a8cb5
                  created: 1494349962314
                  createdClient: MCDPCatalogServiceStage
                  createdUser: MCDPCatalogServiceStage@AdobeID
                  updatedUser: MCDPCatalogServiceStage@AdobeID
                  updated: 1494349963467
                  externalId: /adobe/bulkingest/5af9ee67e4045c1b4945c209
                  status: success
                  errors:
                  - code: err-1494349963436
                  version: 1.0.3
                  availableDates:
                    startDate: 1337
                    endDate: 4000
                  relatedObjects:
                  - type: batch
                    id: foo_batch
                  - type: dataSet
                    id: foo_dataSet
                  - type: dataSetView
                    id: foo_dataSetView
                  - type: dataSetFile
                    id: foo_dataSetFile
                  - type: expressionBlock
                    id: foo_expressionBlock
                  - type: service
                    id: foo_service
                  - type: serviceDefinition
                    id: foo_serviceDefinition
                  metrics:
                    foo: 1337
                  tags:
                    foo_bar:
                    - stuff
                    bar_foo:
                    - woo
                    - baz
                    foo/bar/foo-bar:
                    - weehaw
                    - wee:haw
                  inputFormat:
                    format: parquet
                    delimiter: .
                    quote: '`'
                    escape: \
                    nullMarker: ''
                    header: 'true'
                    charset: UTF-8
        400:
          description: A bad request.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        404:
          description: The specified batch was not found.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
    put:
      tags:
      - Batches
      summary: Update a batch
      description: This request updates a specific batch based on the {BATCH_ID} specified.
      operationId: updateBatch
      parameters:
      - name: BATCH_ID
        in: path
        description: The ID of the batch you are performing the operation on.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      - $ref: '#/components/parameters/if-match'
      - $ref: '#/components/parameters/if-none-match'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: The batch information to be updated.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/batchRequest'
        required: true
      responses:
        200:
          description: Array[ @/batches/batchId ]
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        400:
          description: A bad request.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        404:
          description: Not found
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
      x-codegen-request-body-name: batch
    post:
      tags:
      - Batches
      summary: Create a new batch
      description: This request creates a new batch for operations and applications that have been performed on objects tracked by the system, using the ID value of an existing dataset.
      operationId: createBatchWithId
      parameters:
      - name: BATCH_ID
        in: path
        description: The ID of the batch you are performing the operation on.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: Batch to be created.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/batchRequest'
        required: true
      responses:
        201:
          description: Array[ @/batches/batchId ]
          headers:
            Location:
              description: The URI of the newly created resource.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        400:
          description: A bad request.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
      x-codegen-request-body-name: batch
    delete:
      tags:
      - Batches
      summary: Delete a batch
      description: '**Note:** This endpoint has been deprecated. Please use the [delete a batch endpoint](https://experienceleague.adobe.com/docs/experience-platform/ingestion/batch/api-overview.html#delete-a-batch) within the batch ingestion API.'
      operationId: deleteBatch
      parameters:
      - name: BATCH_ID
        in: path
        description: The ID of the batch you are performing the operation on.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      responses:
        200:
          description: Array[ @/batches/batchId ]
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        400:
          description: A bad request.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        404:
          description: The batch was not found.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
      deprecated: true
    patch:
      tags:
      - Batches
      summary: Update one or more batch attributes
      description: This request allows you to update specified attributes of an existing batch.
      operationId: patchBatch
      parameters:
      - name: BATCH_ID
        in: path
        description: The ID of the batch you are performing the operation on.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/if-none-match'
      requestBody:
        description: The batch that is to be updated.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/batchPatchRequest'
        required: true
      responses:
        200:
          description: Array[ @/batches/batchId ]
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        400:
          description: A bad request.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        404:
          description: The specified batch was not found.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
      x-codegen-request-body-name: batch
    servers:
    - url: //{environment}.adobe.io/data/foundation/catalog
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /batch/execute:
    post:
      tags:
      - Batches
      summary: Execute a batch of assets through a workflow
      description: '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.

        '
      operationId: batchExecute
      security:
      - BearerAuth: []
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchExecuteRequest'
            example:
              workflow:
                workflowId: 121dc48a-f50b-427a-8aeb-f84c12c946a8
                inputs:
                - - node_id: node_1775258981781_301b7cc7v_0_j5iaha
                    content:
                    - presignedUrl: '{presigned_url_1}'
                      storageType: AWS
                    - presignedUrl: '{presigned_url_2}'
                      storageType: AWS
                  - node_id: node_1775258983939_zoc3490s7_1_7jx86h
                    content:
                    - presignedUrl: '{presigned_url_1}'
                      storageType: AWS
                    - presignedUrl: '{presigned_url_2}'
                      storageType: AWS
                  - node_id: node_1775258991082_1lfvzsgqz_2_vhjjoc
                    content: '{text}'
                  - node_id: node_1775259058091_zzgybxfcg_5_j6g2al
                    content: '{text}'
                  - node_id: node-1775259002055-ztu8i4fpz
                    template:
                      presignedUrl: '{presignedUrl}'
                      storageType: AWS
      responses:
        '202':
          description: Accepted
          headers:
            api-version:
              $ref: '#/components/headers/ApiVersionResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchExecuteAcceptedResponse'
              example:
                batchId: batch-run-workflow_2402b5a2-bd2b-4309-a4a4-d7983bba64e9-20260403-750642eb
                workflowId: run-workflow_2402b5a2-bd2b-4309-a4a4-d7983bba64e9
                status: pending
                assets:
                  total: 1
                  pending: 1
                  processing: 0
                  completed: 0
                  failed: 0
                createdAt: '2026-04-03T23:46:39.374Z'
                links:
                  result:
                    href: https://run-workflow.adobe.io/batch/batch-run-workflow_2402b5a2-bd2b-4309-a4a4-d7983bba64e9-20260403-750642eb/status?format=preview
                  status:
                    href: https://run-workflow.adobe.io/batch/batch-run-workflow_2402b5a2-bd2b-4309-a4a4-d7983bba64e9-20260403-750642eb/status
                  cancel:
                    href: https://run-workflow.adobe.io/batch/batch-run-workflow_2402b5a2-bd2b-4309-a4a4-d7983bba64e9-20260403-750642eb/cancel
                  executions:
                    href: https://run-workflow.adobe.io/batch/batch-run-workflow_2402b5a2-bd2b-4309-a4a4-d7983bba64e9-20260403-750642eb/executions
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    servers:
    - url: https://run-workflow.adobe.io
      description: Production
  /batch/{batchId}/status:
    get:
      tags:
      - Batches
      summary: Get batch status
      description: 'Get the current status and progress of a batch job.


        Returns the batch identifier, workflow identifier, status, asset and execution counters (including execution IDs), timestamps, and hypermedia links to cancel or list executions.

        '
      operationId: getBatchStatus
      security:
      - BearerAuth: []
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - name: batchId
        in: path
        required: true
        description: Batch identifier.
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers:
            api-version:
              $ref: '#/c

# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-batches-api-openapi.yml