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 Events API
version: 1.0.0
extends: openapi/antavo-events-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['/events/bulk'].post
update:
x-apievangelist-phrasing:
intent: Submit many loyalty events in one request
effect: write
questions:
- How do I send a batch of customer events in a single call instead of one at a time?
- Are events in a bulk submission processed individually or all at once?
- Can a bulk event submission link customers by an external ID from another system?
instructions:
- text: 'Submit these events in bulk: {events}.'
slots:
events: requestBody.events
- text: Send the batch of checkout and point events {events} in one request.
slots:
events: requestBody.events
method: generated
generated: '2026-10-01'
- target: $.paths['/events'].post
update:
x-apievangelist-phrasing:
intent: Submit a single loyalty event for a customer
effect: write
questions:
- How do I record one checkout or point_add event for a customer?
- Can I add points to a single member by submitting an event?
- Which event types can be sent for one customer, and where is the full list?
instructions:
- text: Submit a single point_add event for one customer.
- text: Send one checkout event for a loyalty member.
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/customers/{customer_id}/events'].get
update:
x-apievangelist-phrasing:
intent: List a customer's event history
effect: read
questions:
- What events are in a customer's loyalty history?
- Can I filter a member's past events by action, date or points?
- Does the customer event history support pagination and sorting?
instructions:
- text: List the event history for customer {customer_id}.
slots:
customer_id: path.customer_id
- text: Show the first {limit} events for customer {customer_id}, filtered by {filter}.
slots:
limit: query.limit
customer_id: path.customer_id
filter: query.filter
- text: List customer {customer_id}'s events sorted by {sort}.
slots:
customer_id: path.customer_id
sort: query.sort
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.