Generated by API Evangelist
Written by API Evangelist tooling for Vendasta's API. It is a proposal applied on top of the contract, not a document Vendasta publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Platform REST Automations API
version: 1.0.0
extends: openapi/vendasta-automations-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: 4
- target: $.paths['/automations'].get
update:
x-apievangelist-phrasing:
intent: List automations in a namespace
effect: read
questions:
- What automations are set up for an account or partner?
- Can I filter automations by status, tag or trigger?
instructions:
- text: List automations in namespace {namespace}.
slots:
namespace: query.filter[namespace]
- text: Show {status} automations in {namespace} tagged {tags}.
slots:
status: query.filter[statuses]
namespace: query.filter[namespace]
tags: query.filter[tags]
- text: Find automations in {namespace} named {name}.
slots:
namespace: query.filter[namespace]
name: query.filter[name]
method: generated
generated: '2026-10-01'
- target: $.paths['/automations'].options
update:
x-apievangelist-phrasing:
intent: Check allowed methods on the automations list
effect: read
questions:
- Which HTTP verbs does the automations collection allow for browsers?
- What does a CORS preflight to /automations return?
instructions:
- text: Send an OPTIONS preflight to the automations collection.
- text: List permitted verbs on the automations list endpoint.
method: generated
generated: '2026-10-01'
- target: $.paths['/automations/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one automation
effect: read
questions:
- What does a specific automation do and how is it set up?
- Can I look up an automation by its ID?
instructions:
- text: Get automation {id}.
slots:
id: path.id
- text: Show the details of automation {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/automations/{id}'].options
update:
x-apievangelist-phrasing:
intent: Check allowed methods on one automation
effect: read
questions:
- Which verbs can a browser use on a single automation URL?
- Does one automation resource respond to CORS preflights?
instructions:
- text: Run a CORS preflight on automation {id}.
slots:
id: path.id
- text: Show allowed HTTP methods for the automation {id} resource.
slots:
id: path.id
method: generated
generated: '2026-10-01'
Discovery needs no key. Ratings and market analysis are Pro.
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.