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 Adobe Suite Session API
version: 1.0.0
extends: openapi/adobe-suite-session-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: 4
- target: $.paths['/sessionStart'].post
update:
x-apievangelist-phrasing:
intent: Start a media tracking session
effect: write
questions:
- How do I begin tracking a video playback session with the Adobe Media Edge API?
- What ID do I need to keep from the start call for later playback events?
instructions:
- text: Start a media session on datastream {configId}.
slots:
configId: query.configId
- text: Open a new playback tracking session for datastream {configId} with events {events}.
slots:
configId: query.configId
events: requestBody.events
method: generated
generated: '2026-09-26'
- target: $.paths['/sessionComplete'].post
update:
x-apievangelist-phrasing:
intent: Mark a media session as watched to the end
effect: write
questions:
- How do I signal that a viewer reached the end of the main content?
- Which event tells media analytics the video was fully completed?
instructions:
- text: 'Send a session complete event: the viewer finished the content.'
- text: Report the media session as completed with events {events}.
slots:
events: requestBody.events
method: generated
generated: '2026-09-26'
- target: $.paths['/sessionEnd'].post
update:
x-apievangelist-phrasing:
intent: Close an abandoned media session immediately
effect: destructive
questions:
- The viewer left mid-video — how do I close the session right away instead of waiting for the timeout?
- What happens to a media session if I never send an end event?
instructions:
- text: End the media session now because the viewer abandoned playback.
- text: Close the playback session immediately with events {events}.
slots:
events: requestBody.events
method: generated
generated: '2026-09-26'
- target: $.paths['/session'].get
update:
x-apievangelist-phrasing:
intent: Get media session information
effect: read
questions:
- Can I read back information about the current media tracking session?
- Is there a GET call that returns session details for media tracking?
instructions:
- text: Get the media session information.
- text: Show me what the Edge server knows about my playback session.
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.