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 Real-time Customer Profile Entities API
version: 1.0.0
extends: openapi/adobe-suite-entities-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['/ups/access/entities'].get
update:
x-apievangelist-phrasing:
intent: Look up a profile or entity by identity
effect: read
questions:
- How do I pull a customer's real-time profile using an identity like an email?
- Can I fetch experience events for an entity within a time range?
- Which merge policy is applied when I retrieve a single entity?
instructions:
- text: Get the {schema.name} entity {entityId} in namespace {entityIdNS}.
slots:
schema.name: query.schema.name
entityId: query.entityId
entityIdNS: query.entityIdNS
- text: Fetch {schema.name} records for {entityId} between {startTime} and {endTime}.
slots:
schema.name: query.schema.name
entityId: query.entityId
startTime: query.startTime
endTime: query.endTime
method: generated
generated: '2026-09-26'
- target: $.paths['/ups/access/entities'].post
update:
x-apievangelist-phrasing:
intent: Look up many profiles by identity at once
effect: read
questions:
- Can I retrieve profiles for a whole list of identities in one request?
- Is there a batch lookup for multiple entities with a time filter?
instructions:
- text: Fetch {schema} entities for identities {identities}.
slots:
schema: requestBody.schema
identities: requestBody.identities
- text: Batch look up identities {identities} in schema {schema} filtered by {timeFilter}.
slots:
identities: requestBody.identities
schema: requestBody.schema
timeFilter: requestBody.timeFilter
method: generated
generated: '2026-09-26'
- target: $.paths['/ups/access/entities'].delete
update:
x-apievangelist-phrasing:
intent: Delete an entity from the profile store
effect: destructive
questions:
- How do I delete a single profile entity by its identity?
- Can I remove an entity from a specific schema only?
instructions:
- text: Delete {schema.name} entity {entityId} in namespace {entityIdNS}.
slots:
schema.name: query.schema.name
entityId: query.entityId
entityIdNS: query.entityIdNS
- text: Remove entity {entityId} from {schema.name}.
slots:
entityId: query.entityId
schema.name: query.schema.name
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.