Adobe Suite · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/adobe-suite-server-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 3

$.info
$.paths['/v2/interact'].post
$.paths['/v2/collect'].post

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 Platform Edge Network Server-to-server…
  version: 1.0.0
extends: openapi/adobe-suite-server-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: 2
- target: $.paths['/v2/interact'].post
  update:
    x-apievangelist-phrasing:
      intent: Send one server-side event and get a response
      effect: write
      questions:
      - How do I send an authenticated event from my server and get personalization back?
      - Can a server-to-server interact call carry a first-party device ID?
      instructions:
      - text: Send authenticated event {event} to datastream {datastreamId} and return the response.
        slots:
          event: requestBody.event
          datastreamId: query.datastreamId
      - text: Interact with datastream {datastreamId} from my server for this visitor.
        slots:
          datastreamId: query.datastreamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/collect'].post
  update:
    x-apievangelist-phrasing:
      intent: Batch-send server-side events without a response
      effect: write
      questions:
      - How can my server push many events from different users in one authenticated call?
      - Can I suppress the response body when collecting events server-side?
      instructions:
      - text: Collect events {events} into datastream {datastreamId} from my server.
        slots:
          events: requestBody.events
          datastreamId: query.datastreamId
      - text: Send the batch to datastream {datastreamId} silently with silent set to {silent}.
        slots:
          datastreamId: query.datastreamId
          silent: query.silent
      method: generated
      generated: '2026-10-01'