Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Experience Platform Edge Network Client-to-server…

4 actions 4 updates phrasing extends openapi/adobe-suite-client-to-server-collection-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v1/interact'].post

$.paths['/v1/collect'].post

$.paths['/v1/identity/acquire'].post

OpenAPI Overlay

# 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 Platform Edge Network Client-to-server…
  version: 1.0.0
extends: openapi/adobe-suite-client-to-server-collection-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: 3
- target: $.paths['/v1/interact'].post
  update:
    x-apievangelist-phrasing:
      intent: Send one browser event and get a personalized response
      effect: write
      questions:
      - How do I send a single unauthenticated event to the Edge Network and get personalization back?
      - Can I pass a first-party device ID cookie with a client-side interact call?
      instructions:
      - text: Send this event to datastream {configId} and return the real-time response.
        slots:
          configId: query.configId
      - text: Post interact event {events} to datastream {configId} with device ID {FPID}.
        slots:
          events: requestBody.events
          configId: query.configId
          FPID: cookie.FPID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/collect'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a batch of client events without a response
      effect: write
      questions:
      - How can I push several events from different visitors in one unauthenticated call?
      - Is there a fire-and-forget way to collect events when I don't need any response content?
      instructions:
      - text: Collect these events {events} into datastream {configId} without waiting for a response.
        slots:
          events: requestBody.events
          configId: query.configId
      - text: Batch-send the queued visitor events to datastream {configId}.
        slots:
          configId: query.configId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/identity/acquire'].post
  update:
    x-apievangelist-phrasing:
      intent: Acquire visitor identities for given namespaces
      effect: write
      questions:
      - How do I fetch an ECID or other identity for a visitor from the Edge Network?
      - Which identity namespaces can I request identities for in one call?
      instructions:
      - text: Acquire the identities for the requested namespaces through datastream {configId}.
        slots:
          configId: query.configId
      - text: Fetch visitor identities via datastream {configId} using query {query}.
        slots:
          configId: query.configId
          query: requestBody.query
      method: generated
      generated: '2026-10-01'