Tray.ai · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Tray Ai Triggers API
10 actions
10 updates
phrasing
extends
openapi/tray-ai-triggers-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Tray.ai's API. It is a proposal applied on top of the contract, not a document Tray.ai publishes.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/triggers'].get
$.paths['/subscriptions'].post
$.paths['/subscriptions/{subscriptionId}'].delete
$.paths['/core/v1/triggers'].get
$.paths['/core/v1/triggers/{trigger-name}/versions/{trigger-version}/operations'].get
$.paths['/core/v1/subscriptions'].get
$.paths['/core/v1/subscriptions'].post
$.paths['/core/v1/subscriptions/{subscription-id}'].get
$.paths['/core/v1/subscriptions/{subscription-id}'].delete
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Tray Ai Triggers API
version: 1.0.0
extends: openapi/tray-ai-triggers-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: 9
- target: $.paths['/triggers'].get
update:
x-apievangelist-phrasing:
intent: List triggers in the library (unversioned)
effect: read
questions:
- Which real-time triggers can I subscribe to in the Tray.ai trigger library?
- Can I browse triggers on the unversioned /triggers endpoint?
instructions:
- text: List every trigger from the unversioned triggers endpoint.
- text: Show the trigger library so I can pick a real-time event source.
method: generated
generated: '2026-09-26'
- target: $.paths['/subscriptions'].post
update:
x-apievangelist-phrasing:
intent: Subscribe to a trigger (unversioned)
effect: write
questions:
- How do I start receiving real-time events from a connector trigger?
- Does a trigger subscription on the unversioned endpoint need an authId?
instructions:
- text: Subscribe to trigger {trigger} on connector {connector} version {version} using auth {auth} with input {input}.
slots:
trigger: requestBody.triggerName
connector: requestBody.connectorName
version: requestBody.connectorVersion
auth: requestBody.authId
input: requestBody.input
- text: Create an unversioned subscription to {trigger} for {connector} {version}, auth {auth}, input {input}.
slots:
trigger: requestBody.triggerName
connector: requestBody.connectorName
version: requestBody.connectorVersion
auth: requestBody.authId
input: requestBody.input
method: generated
generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a trigger subscription (unversioned)
effect: destructive
questions:
- Can I stop a trigger subscription on the unversioned subscriptions endpoint?
- Which token is required to delete a subscription by id on /subscriptions?
instructions:
- text: Delete subscription {subscription} on the unversioned endpoint.
slots:
subscription: path.subscriptionId
- text: Stop receiving events from subscription {subscription} using the user token.
slots:
subscription: path.subscriptionId
method: generated
generated: '2026-09-26'
- target: $.paths['/core/v1/triggers'].get
update:
x-apievangelist-phrasing:
intent: List triggers with core v1
effect: read
questions:
- What triggers does the core v1 API offer?
- Where do I get trigger names and versions from core v1?
instructions:
- text: List triggers through the core v1 API.
- text: Get the core v1 trigger catalog.
method: generated
generated: '2026-09-26'
- target: $.paths['/core/v1/triggers/{trigger-name}/versions/{trigger-version}/operations'].get
update:
x-apievangelist-phrasing:
intent: List a trigger version's operations
effect: read
questions:
- Which operations does a given trigger version support?
- How do I find the operation to use when subscribing to a trigger?
instructions:
- text: List operations for trigger {trigger} version {version}.
slots:
trigger: path.trigger-name
version: path.trigger-version
- text: Show subscribable operations of {trigger} at version {version}.
slots:
trigger: path.trigger-name
version: path.trigger-version
method: generated
generated: '2026-09-26'
- target: $.paths['/core/v1/subscriptions'].get
update:
x-apievangelist-phrasing:
intent: List trigger subscriptions
effect: read
questions:
- Which trigger subscriptions do I currently have?
- Can I page through my event subscriptions with a cursor?
instructions:
- text: List my trigger subscriptions via core v1.
- text: Show the next {count} subscriptions after cursor {cursor}.
slots:
count: query.first
cursor: query.cursor
method: generated
generated: '2026-09-26'
- target: $.paths['/core/v1/subscriptions'].post
update:
x-apievangelist-phrasing:
intent: Create a trigger subscription to an endpoint
effect: write
questions:
- Can core v1 deliver trigger events to my own endpoint URL?
- Can I tag a core v1 subscription with my own external id?
instructions:
- text: Create subscription {name} to trigger {trigger} operation {operation}, delivering to {endpoint} with input {input}.
slots:
name: requestBody.name
trigger: requestBody.trigger
operation: requestBody.operation
endpoint: requestBody.endpoint
input: requestBody.input
- text: 'Core v1: subscribe {endpoint} to {trigger} {operation} as {name}, input {input}, external id {external_id}.'
slots:
endpoint: requestBody.endpoint
trigger: requestBody.trigger
operation: requestBody.operation
name: requestBody.name
input: requestBody.input
external_id: requestBody.externalId
method: generated
generated: '2026-09-26'
- target: $.paths['/core/v1/subscriptions/{subscription-id}'].get
update:
x-apievangelist-phrasing:
intent: Get a trigger subscription by id
effect: read
questions:
- What are the details of a specific trigger subscription?
- Where is a given subscription sending its events?
instructions:
- text: Get subscription {subscription}.
slots:
subscription: path.subscription-id
- text: Show the endpoint and trigger for subscription {subscription}.
slots:
subscription: path.subscription-id
method: generated
generated: '2026-09-26'
- target: $.paths['/core/v1/subscriptions/{subscription-id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a core v1 trigger subscription
effect: destructive
questions:
- How do I cancel a core v1 subscription so events stop arriving?
- Can I remove a connector events subscription through core v1?
instructions:
- text: Delete core v1 subscription {subscription}.
slots:
subscription: path.subscription-id
- text: Cancel connector events subscription {subscription} via core v1.
slots:
subscription: path.subscription-id
method: generated
generated: '2026-09-26'