Generated by API Evangelist
Written by API Evangelist tooling for Antavo's API. It is a proposal applied on top of the contract, not a document Antavo publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Antavo Display Profiling API
version: 1.0.0
extends: openapi/antavo-profiling-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['/customers/{customer_id}/activities/profiling/{flow_id}/next'].get
update:
x-apievangelist-phrasing:
intent: Get the next profiling question
effect: read
questions:
- What's the next profiling question a member should answer?
- Can I get profiling questions in a specific language?
instructions:
- text: Get the next question in profiling flow {flow_id} for customer {customer_id}.
slots:
flow_id: path.flow_id
customer_id: path.customer_id
- text: Fetch customer {customer_id}'s next question in flow {flow_id} in language {lang}.
slots:
customer_id: path.customer_id
flow_id: path.flow_id
lang: header.Accept-language
method: generated
generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/activities/profiling'].get
update:
x-apievangelist-phrasing:
intent: List profiling flows for a customer
effect: read
questions:
- Which profiling flows can a customer complete?
- Are there profile surveys this member hasn't finished?
instructions:
- text: List profiling flows for customer {customer_id}.
slots:
customer_id: path.customer_id
- text: Show the profile surveys available to member {customer_id}.
slots:
customer_id: path.customer_id
method: generated
generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/activities/profiling/{flow_id}/questions/{question_id}'].post
update:
x-apievangelist-phrasing:
intent: Answer a profiling question
effect: write
questions:
- Can I submit a customer's answer to a profiling question?
- What events are recorded when a profiling answer is saved?
instructions:
- text: Submit answer {answer} to question {question_id} in flow {flow_id} for customer {customer_id}.
slots:
answer: requestBody.answer
question_id: path.question_id
flow_id: path.flow_id
customer_id: path.customer_id
- text: Record customer {customer_id}'s reply {answer} for profiling question {question_id}, flow {flow_id}.
slots:
customer_id: path.customer_id
answer: requestBody.answer
question_id: path.question_id
flow_id: path.flow_id
method: generated
generated: '2026-10-01'
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.