Tray.ai · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Tray Ai Solution Instances API
10 actions
10 updates
phrasing
extends
openapi/tray-ai-solution-instances-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['/graphql#createSolutionInstance'].post
$.paths['/graphql#getSolutionInstances'].post
$.paths['/graphql#updateSolutionInstance'].post
$.paths['/graphql#deleteSolutionInstance'].post
$.paths['/ '].post
$.paths['/ '].post
$.paths['/ '].post
$.paths['/ '].post
$.paths['/ '].post
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 Solution Instances API
version: 1.0.0
extends: openapi/tray-ai-solution-instances-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['/graphql#createSolutionInstance'].post
update:
x-apievangelist-phrasing:
intent: Create a solution instance for an end user
effect: write
questions:
- How do I activate a published integration for one of my end users with the GraphQL createSolutionInstance mutation?
- Can I pass auth values and config values when creating an instance over GraphQL?
instructions:
- text: Run the createSolutionInstance GraphQL mutation with variables {variables} under the user token.
slots:
variables: requestBody.variables
- text: Send GraphQL mutation {mutation} to create a solution instance from a published solution.
slots:
mutation: requestBody.query
method: generated
generated: '2026-09-26'
- target: $.paths['/graphql#getSolutionInstances'].post
update:
x-apievangelist-phrasing:
intent: Query solution instances via GraphQL
effect: read
questions:
- Does a master token return every end user's solution instances in the GraphQL query?
- Can I paginate solution instances when querying them over GraphQL?
instructions:
- text: Run the getSolutionInstances GraphQL query {query}.
slots:
query: requestBody.query
- text: Query GraphQL for the instances owned by the current user token.
method: generated
generated: '2026-09-26'
- target: $.paths['/graphql#updateSolutionInstance'].post
update:
x-apievangelist-phrasing:
intent: Update or enable a solution instance via GraphQL
effect: write
questions:
- How do I enable or disable an end user's solution instance with the GraphQL mutation?
- Should I set errorOnEnablingWithMissingValues when updating an instance over GraphQL?
instructions:
- text: Run the updateSolutionInstance GraphQL mutation with variables {variables}.
slots:
variables: requestBody.variables
- text: Send GraphQL mutation {mutation} to rename an instance and change its config values.
slots:
mutation: requestBody.query
method: generated
generated: '2026-09-26'
- target: $.paths['/graphql#deleteSolutionInstance'].post
update:
x-apievangelist-phrasing:
intent: Delete a solution instance via GraphQL
effect: destructive
questions:
- Is deleting a solution instance through the GraphQL mutation reversible?
- Does removing an instance with the GraphQL API also delete its associated data?
instructions:
- text: Run the deleteSolutionInstance GraphQL mutation for instance {instance}.
slots:
instance: requestBody.variables
- text: Send GraphQL mutation {mutation} to irreversibly delete a solution instance.
slots:
mutation: requestBody.query
method: generated
generated: '2026-09-26'
- target: $.paths['/ '].post
update:
x-apievangelist-phrasing:
intent: Get solution instances from the embedded root
effect: read
questions:
- Can I list solution instances by posting to the embedded root endpoint with a user or master token?
- Which embedded root call returns solution instances?
instructions:
- text: Post a get-solution-instances request to the embedded root filtered by {variables}.
slots:
variables: requestBody.variables
- text: Fetch solution instances through the embedded root endpoint with my master token.
method: generated
generated: '2026-09-26'
- target: $.paths['/ '].post
update:
x-apievangelist-phrasing:
intent: Create a solution instance via the embedded root
effect: write
questions:
- Is there an embedded root call that creates a solution instance with a user token?
- Which user-token request posted to the embedded root sets up a new instance?
instructions:
- text: Post a create-solution-instance request to the embedded root with {variables}.
slots:
variables: requestBody.variables
- text: Set up a new solution instance through the embedded root endpoint using the user token.
method: generated
generated: '2026-09-26'
- target: $.paths['/ '].post
update:
x-apievangelist-phrasing:
intent: Update a solution instance via the embedded root
effect: write
questions:
- Can I change a solution instance by posting to the embedded root with a user token?
- Which embedded root call edits an existing instance's values?
instructions:
- text: Post an update-solution-instance request to the embedded root with {variables}.
slots:
variables: requestBody.variables
- text: Edit an existing instance through the embedded root endpoint with the user token.
method: generated
generated: '2026-09-26'
- target: $.paths['/ '].post
update:
x-apievangelist-phrasing:
intent: Upgrade a solution instance to the latest version
effect: write
questions:
- How do I move an end user's instance onto the newest published solution version?
- What do I do when an instance is not upgraded automatically after a solution release?
instructions:
- text: Upgrade solution instance {variables} to the latest published solution.
slots:
variables: requestBody.variables
- text: Upgrade this user's instance to the new solution version using the user token.
method: generated
generated: '2026-09-26'
- target: $.paths['/ '].post
update:
x-apievangelist-phrasing:
intent: Delete a solution instance via the embedded root
effect: destructive
questions:
- Is there a user-token request to the embedded root that permanently deletes an instance?
- Which embedded root call removes an end user's instance?
instructions:
- text: Post a delete-solution-instance request to the embedded root for {variables}.
slots:
variables: requestBody.variables
- text: Remove the instance through the embedded root endpoint using the user token.
method: generated
generated: '2026-09-26'