Generated by API Evangelist
Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Data Access API
version: 1.0.0
extends: openapi/adobe-suite-data-access-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/batches/{batchId}/files'].get
update:
x-apievangelist-phrasing:
intent: List a batch's dataset files
effect: read
questions:
- Which dataset files were written by a specific ingestion batch?
- Is there a limit on how many batch files come back per request?
instructions:
- text: List the dataset files in batch {batchId}.
slots:
batchId: path.batchId
- text: List dataset files for batch {batchId} starting at {start}, {limit} at a time.
slots:
batchId: path.batchId
start: query.start
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/batches/{batchId}/failed'].get
update:
x-apievangelist-phrasing:
intent: List a failed batch's files
effect: read
questions:
- How do I see the files from a batch that failed ingestion?
- Can I download one specific failed file from a batch?
instructions:
- text: Show the failed files for batch {batchId}.
slots:
batchId: path.batchId
- text: Get the failed file at {path} in batch {batchId}.
slots:
path: query.path
batchId: path.batchId
method: generated
generated: '2026-09-26'
- target: $.paths['/batches/{batchId}/meta'].get
update:
x-apievangelist-phrasing:
intent: Get a batch's meta and row error files
effect: read
questions:
- Where can I find the row errors for an ingestion batch?
- Can I download a specific file from a batch's meta directory?
instructions:
- text: List the meta files for batch {batchId}.
slots:
batchId: path.batchId
- text: Download meta file {path} from batch {batchId}.
slots:
path: query.path
batchId: path.batchId
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.