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 Engine Promotion API
version: 1.0.0
extends: openapi/antavo-promotion-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['/v1/promotion/{promotionId}'].get
update:
x-apievangelist-phrasing:
intent: Get a promotion
effect: read
questions:
- What are the settings of one promotion?
- Can I look up a single promotion by its ID?
instructions:
- text: Get promotion {promotionId}.
slots:
promotionId: path.promotionId
- text: Show the full configuration of promotion {promotionId}.
slots:
promotionId: path.promotionId
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/promotions'].get
update:
x-apievangelist-phrasing:
intent: List promotions
effect: read
questions:
- Which promotions are configured in my workspace?
- Can I sync every promotion with its full settings?
instructions:
- text: List all promotions.
- text: Show every promotion with its settings.
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/promotion/{promotionId}/status'].post
update:
x-apievangelist-phrasing:
intent: Change a promotion's status
effect: write
questions:
- Can I activate a draft promotion or send it back to draft?
- Can an archived promotion be reactivated?
instructions:
- text: Set promotion {promotionId} to status {status}.
slots:
promotionId: path.promotionId
status: requestBody.status
- text: Activate promotion {promotionId} by changing its status to {status}.
slots:
promotionId: path.promotionId
status: requestBody.status
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.