Adobe Experience Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Experience Cloud Adobe Experience Platform Batches API

3 actions 3 updates phrasing extends openapi/adobe-experience-cloud-batches-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Experience Cloud's API. It is a proposal applied on top of the contract, not a document Adobe Experience Cloud publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/data/foundation/import/batches'].post
$.paths['/data/foundation/import/batches/{batchId}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Experience Cloud Adobe Experience Platform Batches API
  version: 1.0.0
extends: openapi/adobe-experience-cloud-batches-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/data/foundation/import/batches'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a data ingestion batch
      effect: write
      questions:
      - How do I begin ingesting files into an Experience Platform dataset?
      - Which input formats can a new ingestion batch use?
      instructions:
      - text: Create an ingestion batch for dataset {datasetId} in {inputFormat} format.
        slots:
          datasetId: requestBody.datasetId
          inputFormat: requestBody.inputFormat
      - text: Open a new batch for dataset {datasetId} in sandbox {sandbox} using {inputFormat}.
        slots:
          datasetId: requestBody.datasetId
          sandbox: header.x-sandbox-name
          inputFormat: requestBody.inputFormat
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data/foundation/import/batches/{batchId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a batch's ingestion status
      effect: read
      questions:
      - Did my data ingestion batch succeed or fail?
      - Where can I see the status and metadata of an ingestion batch?
      instructions:
      - text: Check the status of batch {batchId}.
        slots:
          batchId: path.batchId
      - text: Get batch {batchId} in sandbox {sandbox}.
        slots:
          batchId: path.batchId
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-10-01'