Adobe Suite

Adobe Suite Batches API

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

Documentation GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /batches List ingestion batches in the catalog · Retrieve a list of batches #

Ask an LLM

“How do I list the data batches tracked by the Experience Platform catalog?”

“Can I see only batches that failed or had records that couldn't be processed?”

Tell an agent

List batches for dataset {dataSet}.

Show catalog batches with status {status} created after {createdAfter}.

POST /batches Create a new catalog batch · Create a new batch #

Ask an LLM

“How do I register a new batch in the catalog to track an ingestion?”

“What status must I give a batch when I create it?”

Tell an agent

Create a catalog batch with status {status}.

Create a batch with status {status} and external ID {externalId}.

GET /batches/uniques/{FIELD} Look up distinct values of a batch field · Look up the unique values stored in a field #

Ask an LLM

“How can I see every distinct value stored in one field across my batches?”

“What unique statuses appear across batches in a dataset?”

Tell an agent

Get the unique values of batch field {FIELD}.

List distinct {FIELD} values for batches in dataset {dataSet}.

GET /batches/{BATCH_ID} Look up a catalog batch · Look up a batch #

Ask an LLM

“How do I get the details of one catalog batch by its ID?”

“Can I get aggregated status, metrics and errors for a batch in one response?”

Tell an agent

Show catalog batch {BATCH_ID}.

Get batch {BATCH_ID} with aggregate={aggregate}.

PUT /batches/{BATCH_ID} Replace a catalog batch's details · Update a batch #

Ask an LLM

“How do I overwrite a batch record with a full new version?”

“Can I guard a full batch update with an if-match version check?”

Tell an agent

Replace batch {BATCH_ID} with status {status}.

Fully update batch {BATCH_ID} only if version {if-match} matches.

POST /batches/{BATCH_ID} Create a catalog batch under a chosen ID · Create a new batch #

Ask an LLM

“Can I create a batch using a specific ID instead of letting the catalog assign one?”

“How do I create a batch at a known batch ID path?”

Tell an agent

Create batch {BATCH_ID} with status {status}.

Register a new batch at ID {BATCH_ID} holding {recordCount} records.

DELETE /batches/{BATCH_ID} Delete a catalog batch (deprecated) · Delete a batch #

Ask an LLM

“How do I delete a batch record from the catalog?”

“Is the catalog's delete-batch endpoint still supported?”

Tell an agent destructive · confirm first

Delete catalog batch {BATCH_ID}.

Remove batch {BATCH_ID} using the deprecated catalog endpoint.

PATCH /batches/{BATCH_ID} Update selected fields on a catalog batch · Update one or more batch attributes #

Ask an LLM

“Can I change just a few attributes of a batch without resending all of it?”

“How do I patch the failed record count on an existing batch?”

Tell an agent

Set the status of batch {BATCH_ID} to {status}.

Patch batch {BATCH_ID} to record {failedRecordCount} failed records.

POST /batch/execute Run many assets through a published workflow · Execute a batch of assets through a workflow #

Ask an LLM

“How do I process a batch of assets through one of my published workflows?”

“Can each run in a workflow batch supply different inputs per node?”

Tell an agent

Start a workflow batch job with {workflow}.

Execute my published workflow over these assets as one batch.

GET /batch/{batchId}/status Check progress of a workflow batch job · Get batch status #

Ask an LLM

“How far along is my workflow batch job?”

“Can I see how many assets in a workflow batch have finished or failed?”

Tell an agent

Get the status of workflow batch {batchId}.

Show progress counters for batch job {batchId}.

POST /batch/{batchId}/cancel Cancel a running workflow batch job · Cancel a batch #

Ask an LLM

“How do I stop a workflow batch that's still pending or running?”

“Will assets already being processed finish if I cancel the batch?”

Tell an agent destructive · confirm first

Cancel workflow batch {batchId}.

Stop batch job {batchId} so no more assets are processed.

GET /batch/{batchId}/executions List per-asset results in a workflow batch · List individual execution results #

Ask an LLM

“How do I see the result for each asset processed in a workflow batch?”

“Can I list only the failed executions in a batch job?”

Tell an agent

List executions in workflow batch {batchId}.

Show {status} executions for batch {batchId}.

Documentation

https://developer.adobe.com/photoshop/api/docs/

https://developer.adobe.com/developer-console/docs/guides/authentication/

https://developer.adobe.com/lightroom/api/docs/

https://developer.adobe.com/illustrator/api/docs/

https://developer.adobe.com/indesign/docs/

https://developer.adobe.com/document-services/docs/overview/pdf-services-api/

https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/

https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/gettingstarted/

https://developer.adobe.com/document-services/docs/overview/pdf-accessibility-auto-tag-api/

https://developer.adobe.com/analytics-apis/docs/

https://developer.adobe.com/analytics-apis/docs/2.0/

https://developer.adobe.com/firefly-services/docs/

https://developer.adobe.com/firefly-services/docs/api/

https://developer.adobe.com/audio-video-firefly-services/

https://developer.adobe.com/audio-video-firefly-services/getting-started/

https://developer.adobe.com/creative-cloud-libraries/docs/

https://developer.adobe.com/creative-cloud-libraries/docs/api/

https://developer.adobe.com/express/embed-sdk/docs/guides/

https://developer.adobe.com/express/embed-sdk/docs/v4/

https://developer.adobe.com/express/embed-sdk/docs/guides/quickstart/

https://developer.adobe.com/experience-platform-apis/

https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-guide

https://developer.adobe.com/marketo-apis/

https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/authentication

https://developer.adobe.com/commerce/docs/

https://developer.adobe.com/commerce/webapi/get-started/

https://developer.adobe.com/experience-cloud/cloud-manager/

https://developer.adobe.com/journey-optimizer-apis/

https://developer.adobe.com/workfront-apis/

https://developer.adobe.com/firefly-services/docs/substance3d/

https://developer.adobe.com/data-collection-apis/

https://developer.adobe.com/adobe-status/

https://developer.adobe.com/vip-marketplace/

Specifications

https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-batches-api-openapi.yml

Other Resources

https://developer.adobe.com/document-services/pricing/

https://developer.adobe.com/document-services/docs/overview/pdf-services-api/sdks/

https://developer.adobe.com/document-services/docs/overview/pdf-services-api/releasenotes

https://developer.adobe.com/analytics-apis/docs/2.0/guides/

https://developer.adobe.com/firefly-services/docs/guides/

https://developer.adobe.com/audio-video-firefly-services/getting_started/usage/

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

https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/rest-api

https://developer.adobe.com/commerce/webapi/rest/

https://developer.adobe.com/commerce/webapi/graphql-api/

REST API Reference

https://developer.adobe.com/commerce/webapi/reference/rest/paas/

https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/graphql/adobe-suite-graphql.md

https://developer.adobe.com/experience-cloud/cloud-manager/guides/getting-started/create-event-integration/

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: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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

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:


# --- 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