# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Relevance AI Endpoints Chat API version: 1.0.0 extends: openapi/relevance-ai-chat-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: 171 - target: $.paths['/phone-numbers'].get update: x-apievangelist-phrasing: intent: List phone numbers assigned to the project effect: read questions: - Which phone numbers are assigned to my Relevance AI project? - Can I see only the project phone numbers from one telephony provider? instructions: - text: List every phone number assigned to this project. - text: Show the project phone numbers that come from provider {provider}. slots: provider: query.provider method: generated generated: '2026-09-26' - target: $.paths['/agents/clone'].post update: x-apievangelist-phrasing: intent: Deep clone an agent with its tools and subagents effect: write questions: - How do I make a full copy of an agent including all its tools and subagents? - Can I add a name prefix to the copies when cloning an agent recursively? instructions: - text: Deep clone agent template {template} with all its tools and subagents. slots: template: requestBody.template - text: Clone agent {template} recursively and prefix the copied names with {prefix}. slots: template: requestBody.template prefix: requestBody.prefix method: generated generated: '2026-09-26' - target: $.paths['/agents/clone_marketplace_template'].post update: x-apievangelist-phrasing: intent: Clone a marketplace agent template effect: write questions: - Can I copy an agent from a marketplace template into my own project? - What gets copied when I clone a marketplace agent template, tools and subagents too? instructions: - text: Clone marketplace template {template} into my project. slots: template: requestBody.template - text: Install the marketplace agent template {template} as my own agent with its tools. slots: template: requestBody.template method: generated generated: '2026-09-26' - target: $.paths['/agents/upsert'].post update: x-apievangelist-phrasing: intent: Create or update an agent's configuration effect: write questions: - How do I create a new agent or update an existing one without overwriting it? - Can I set an agent's system prompt and model in the same create-or-update call? - Does updating an agent's live config merge fields rather than replace the whole agent? instructions: - text: Create or update agent {agent_id} named {name}. slots: agent_id: requestBody.agent_id name: requestBody.name - text: Set the system prompt of agent {agent_id} to {system_prompt} and use model {model}. slots: agent_id: requestBody.agent_id system_prompt: requestBody.system_prompt model: requestBody.model - text: Change the temperature of agent {agent_id} to {temperature}. slots: agent_id: requestBody.agent_id temperature: requestBody.temperature method: generated generated: '2026-09-26' - target: $.paths['/agents/upsert_preset'].post update: x-apievangelist-phrasing: intent: Set up a preset agent such as a meeting notetaker effect: write questions: - How do I add a ready-made preset agent like the meeting notetaker to my project? - Can I force a preset agent to be created as a brand-new agent instead of updating the existing one? instructions: - text: Set up preset agent {preset_agent_id} in my project. slots: preset_agent_id: requestBody.preset_agent_id - text: Install preset agent {preset_agent_id} as a new agent and sync its evals ({sync_evals}). slots: preset_agent_id: requestBody.preset_agent_id sync_evals: requestBody.sync_evals method: generated generated: '2026-09-26' - target: $.paths['/agents/list'].post update: x-apievangelist-phrasing: intent: Search and filter agents in the project effect: read questions: - Can I search all agents in my project by keyword and filters? - Is there a way to include public agents when searching the agent list? instructions: - text: Search the project's agents for {query}. slots: query: requestBody.query - text: Find agents matching {query}, including public agents, page {page}. slots: query: requestBody.query page: requestBody.page method: generated generated: '2026-09-26' - target: $.paths['/agents/list-my-agents'].post update: x-apievangelist-phrasing: intent: List agents I created effect: read questions: - Which agents have I personally created? - Can I page through only my own agents, sorted my way? instructions: - text: List the agents I created. - text: Show my own agents, {page_size} per page, sorted by {sort}. slots: page_size: requestBody.page_size sort: requestBody.sort method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/get'].get update: x-apievangelist-phrasing: intent: Get an agent's details effect: read questions: - How do I fetch the full configuration of one agent? - Can I retrieve a specific version of an agent rather than the current one? instructions: - text: Get agent {agent_id}. slots: agent_id: path.agent_id - text: Retrieve agent {agent_id} at version {version}. slots: agent_id: path.agent_id version: query.version method: generated generated: '2026-09-26' - target: $.paths['/agents/tools/list'].post update: x-apievangelist-phrasing: intent: List tools across several agents effect: read questions: - What tools are used by a set of agents at once? - Can I get a combined tools view for multiple agent IDs in one call? instructions: - text: Show the tools used by agents {agent_ids}. slots: agent_ids: requestBody.agent_ids - text: 'List tools for this batch of agents: {agent_ids}.' slots: agent_ids: requestBody.agent_ids method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/tools/list'].post update: x-apievangelist-phrasing: intent: Get the tools attached to one agent effect: read questions: - Which tools is a single agent allowed to use? - Can I include phantom tools when listing one agent's tools? instructions: - text: List the tools attached to agent {agent_id}. slots: agent_id: path.agent_id - text: Show tools for agent {agent_id} at version {agent_version}, including phantom tools. slots: agent_id: path.agent_id agent_version: requestBody.agent_version method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/dependency-versions/metadata/list'].post update: x-apievangelist-phrasing: intent: List metadata for an agent's pinned dependencies effect: read questions: - What versions are my agent's pinned subagent dependencies on? - Can I get display details for the agents that another agent depends on? instructions: - text: Show pinned dependency metadata for agent {agent_id} covering {dependencies}. slots: agent_id: path.agent_id dependencies: requestBody.dependencies - text: List the pinned direct agent dependencies {dependencies} of agent {agent_id}. slots: agent_id: path.agent_id dependencies: requestBody.dependencies method: generated generated: '2026-09-26' - target: $.paths['/agents/trigger'].post update: x-apievangelist-phrasing: intent: Send a message to an agent to run it effect: write questions: - How do I start an agent run by sending it a message through the API? - Can I continue an existing conversation when triggering an agent? - Is it possible to cap how long a triggered agent job may run? instructions: - text: Trigger agent {agent_id}. slots: agent_id: requestBody.agent_id - text: Send agent {agent_id} a new run in conversation {conversation_id}. slots: agent_id: requestBody.agent_id conversation_id: requestBody.conversation_id - text: Run agent {agent_id} with a max job duration of {max_job_duration}. slots: agent_id: requestBody.agent_id max_job_duration: requestBody.max_job_duration method: generated generated: '2026-09-26' - target: $.paths['/agents/bulk_trigger'].post update: x-apievangelist-phrasing: intent: Trigger an agent in bulk across rows effect: write questions: - Can I trigger an agent over many rows at once instead of one message at a time? - What limits how many rows a bulk agent trigger processes at once? instructions: - text: Bulk trigger agent {agent_id} across the matching rows. slots: agent_id: requestBody.agent_id - text: Bulk run agent {agent_id} with at most {max_rows_at_once} rows at once. slots: agent_id: requestBody.agent_id max_rows_at_once: requestBody.max_rows_at_once method: generated generated: '2026-09-26' - target: $.paths['/agents/get_embed_key'].post update: x-apievangelist-phrasing: intent: Get an embed key for an agent effect: write questions: - How do I get a key to embed an agent on my website? - Where does the embed key for a single agent come from? instructions: - text: Generate an embed key for agent {agent_id} in project {project}. slots: agent_id: requestBody.agent_id project: requestBody.project - text: Give me the embed key for agent {agent_id}, project {project}. slots: agent_id: requestBody.agent_id project: requestBody.project method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/delete'].post update: x-apievangelist-phrasing: intent: Delete an agent effect: destructive questions: - How do I permanently remove an agent from my project? - What happens when I delete an agent I no longer use? instructions: - text: Delete agent {agent_id}. slots: agent_id: path.agent_id - text: Remove the agent {agent_id} from the project. slots: agent_id: path.agent_id method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/suggest_replies'].post update: x-apievangelist-phrasing: intent: Suggest replies to an agent's latest message effect: read questions: - Can I get suggested replies to the last message an agent sent in a conversation? - Is it possible to steer the reply suggestions with my own instructions? instructions: - text: Suggest replies for conversation {conversation_id} with agent {agent_id}. slots: conversation_id: requestBody.conversation_id agent_id: path.agent_id - text: Draft reply suggestions in conversation {conversation_id} of agent {agent_id} following {instructions}. slots: conversation_id: requestBody.conversation_id agent_id: path.agent_id instructions: requestBody.instructions method: generated generated: '2026-09-26' - target: $.paths['/agents/prompt_models/list'].get update: x-apievangelist-phrasing: intent: List LLMs supported for agent prompts effect: read questions: - Which LLMs are supported for agent prompts? - What prompt models can I pick when configuring an agent? instructions: - text: List the supported prompt LLMs for agents. - text: Show me the agent prompt model options. method: generated generated: '2026-09-26' - target: $.paths['/agents/models/list'].get update: x-apievangelist-phrasing: intent: List available LLMs effect: read questions: - What large language models are available on the platform? - Can I narrow the LLM catalog to a particular model subset? instructions: - text: List all available LLMs. - text: List LLMs in model subset {model_subset}. slots: model_subset: query.model_subset method: generated generated: '2026-09-26' - target: $.paths['/agents/models/stt/list'].get update: x-apievangelist-phrasing: intent: List speech-to-text models effect: read questions: - Which speech-to-text models can a voice agent use? - What transcription models are available? instructions: - text: List the speech-to-text models. - text: Show available STT models for voice agents. method: generated generated: '2026-09-26' - target: $.paths['/agents/models/tts/list'].get update: x-apievangelist-phrasing: intent: List text-to-speech models effect: read questions: - Which text-to-speech voices or models can my agent speak with? - What TTS models are offered? instructions: - text: Show the voice models agents can speak with. - text: Show available TTS models for voice output. method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/scheduled_triggers_group/upsert'].post update: x-apievangelist-phrasing: intent: Configure an agent's scheduled message group effect: write questions: - Can I cap how many scheduled messages an agent may have queued? - Is there a way to stop scheduled messages firing while a conversation is still active? instructions: - text: Set up the scheduled trigger group for agent {agent_id} with a max of {max_count}. slots: agent_id: path.agent_id max_count: requestBody.max_count - text: 'For agent {agent_id}, skip scheduled triggers while a conversation is active: {prevent_triggering_if_conversation_active}.' slots: agent_id: path.agent_id prevent_triggering_if_conversation_active: requestBody.prevent_triggering_if_conversation_active method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/scheduled_triggers_item/create'].post update: x-apievangelist-phrasing: intent: Schedule a future message for an agent effect: write questions: - How do I schedule a message to an agent to be sent a few minutes from now? - Can an agent send itself a follow-up message later in the same conversation? instructions: - text: Schedule message {message} to agent {agent_id} in conversation {conversation_id} in {minutes_until_schedule} minutes. slots: message: requestBody.message agent_id: path.agent_id conversation_id: requestBody.conversation_id minutes_until_schedule: requestBody.minutes_until_schedule - text: Queue a follow-up {message} for agent {agent_id}, conversation {conversation_id}, after {minutes_until_schedule} minutes. slots: message: requestBody.message agent_id: path.agent_id conversation_id: requestBody.conversation_id minutes_until_schedule: requestBody.minutes_until_schedule method: generated generated: '2026-09-26' - target: $.paths['/trigger/recurring/callback'].post update: x-apievangelist-phrasing: intent: Fire a recurring trigger effect: write questions: - How is a recurring sync trigger fired through its callback? - Can a recurring trigger be fired as a one-off with a custom message? instructions: - text: Fire recurring trigger {sync_id} for user {key_user_id} in project {project}. slots: sync_id: requestBody.sync_id key_user_id: requestBody.key_user_id project: requestBody.project - text: Run recurring trigger {sync_id} once with message {message} for user {key_user_id} in project {project}. slots: sync_id: requestBody.sync_id message: requestBody.message key_user_id: requestBody.key_user_id project: requestBody.project method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/scheduled_triggers_item/cancel'].post update: x-apievangelist-phrasing: intent: Cancel a scheduled agent message effect: destructive questions: - How do I cancel a message I scheduled for an agent before it sends? - Can I stop one scheduled agent message without touching the others? instructions: - text: Cancel scheduled message {trigger_id} for agent {agent_id}. slots: trigger_id: requestBody.trigger_id agent_id: path.agent_id - text: Stop the pending scheduled trigger {trigger_id} on agent {agent_id}. slots: trigger_id: requestBody.trigger_id agent_id: path.agent_id method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/generate_requirements'].post update: x-apievangelist-phrasing: intent: Get auth account requirements for an agent's tools effect: read questions: - Which connected accounts does an agent's tools need before it can run? - What auth credentials are my agent's tools missing? instructions: - text: Show the auth account requirements for agent {agent_id}. slots: agent_id: path.agent_id - text: Check which tool accounts agent {agent_id} needs connected. slots: agent_id: path.agent_id method: generated generated: '2026-09-26' - target: $.paths['/agents/aggregate_tagged_conversations'].post update: x-apievangelist-phrasing: intent: Aggregate tagged agent conversations effect: read questions: - Can I get counts of agent conversations grouped by their tags? - Is it possible to run an aggregation query over tagged conversations in a dataset? instructions: - text: Aggregate tagged agent conversations using {aggregation_query}. slots: aggregation_query: requestBody.aggregation_query - text: Summarize tagged conversations in dataset {dataset_id}. slots: dataset_id: requestBody.dataset_id method: generated generated: '2026-09-26' - target: $.paths['/agents/list_custom_metadata'].post update: x-apievangelist-phrasing: intent: List custom metadata fields used by agents effect: read questions: - What custom metadata fields are defined across my agents? - Can I see the custom metadata keys on one particular agent? instructions: - text: List all custom metadata fields across agents. - text: Show custom metadata fields for agent {agent_id}. slots: agent_id: requestBody.agent_id method: generated generated: '2026-09-26' - target: $.paths['/agents/generate_params_schema'].post update: x-apievangelist-phrasing: intent: Generate a params schema from an agent's variables effect: read questions: - Can the platform work out an agent's input params schema from the variables it uses? - How do I get a full params schema generated for an agent definition? instructions: - text: Generate a params schema for agent definition {agent}. slots: agent: requestBody.agent - text: Detect variables in {agent} and output the full params schema. slots: agent: requestBody.agent method: generated generated: '2026-09-26' - target: $.paths['/agents/conversations/list'].get update: x-apievangelist-phrasing: intent: List agent conversations effect: read questions: - How do I list all conversations my agents have had? - Can I mask PII when pulling back agent conversations? - Is it possible to search conversations by text and page through them? instructions: - text: List agent conversations, page {page}. slots: page: query.page - text: Search agent conversations for {query} with PII masked. slots: query: query.query method: generated generated: '2026-09-26' - target: $.paths['/agents/tasks/match-groups/{hash}/conversations'].get update: x-apievangelist-phrasing: intent: List conversations in a match group by hash (deprecated) effect: read questions: - Which conversations belong to a task match group hash on the older deprecated endpoint? - Can I still page through match group conversations by hash? instructions: - text: List conversations for match group hash {hash} using the deprecated endpoint. slots: hash: path.hash - text: Show page {page} of conversations in match group {hash}. slots: page: query.page hash: path.hash method: generated generated: '2026-09-26' - target: $.paths['/agents/tasks/match-group-conversations'].get update: x-apievangelist-phrasing: intent: List conversations matching a task group selector effect: read questions: - What conversations match a task ops group selector? - Can I page through the conversations behind one grouped task view? instructions: - text: List conversations matching task group selector {selector}. slots: selector: query.selector - text: Show {page_size} conversations for group selector {selector}. slots: page_size: query.page_size selector: query.selector method: generated generated: '2026-09-26' - target: $.paths['/agents/tasks/groups'].get update: x-apievangelist-phrasing: intent: List grouped task views with counts effect: read questions: - How are my agent tasks grouped, and how many are in each group? - Can I group task ops by a field other than agent? instructions: - text: Show grouped task counts by agent. - text: Group agent tasks by {group_by} and show counts. slots: group_by: query.group_by method: generated generated: '2026-09-26' - target: $.paths['/agents/tasks/groups/tasks'].get update: x-apievangelist-phrasing: intent: List tasks inside one task group effect: read questions: - Which tasks sit inside a particular grouped task ops group? - Can I include eval details for the tasks in one group? instructions: - text: List the tasks in task group {group}. slots: group: query.group - text: Search tasks in group {group} for {query}. slots: group: query.group query: query.query method: generated generated: '2026-09-26' - target: $.paths['/agents/conversations/export'].get update: x-apievangelist-phrasing: intent: Export agent conversations to CSV effect: read questions: - Can I download my agent conversations as a CSV file? - Is PII masking available when exporting conversations to a spreadsheet? instructions: - text: Export agent conversations to CSV. - text: Export conversations matching {query} to CSV with PII masked. slots: query: query.query method: generated generated: '2026-09-26' - target: $.paths['/agents/conversations/latest_update_datetime'].get update: x-apievangelist-phrasing: intent: Get when an agent's conversations last changed effect: read questions: - When was the most recent conversation update for an agent? - Can I poll for the latest conversation change time to know if anything is new? instructions: - text: Get the latest conversation update time for agent {agent_id}. slots: agent_id: query.agent_id - text: Check when agent {agent_id} last had a conversation update. slots: agent_id: query.agent_id method: generated generated: '2026-09-26' - target: $.paths['/agents/conversations/studios/list'].get update: x-apievangelist-phrasing: intent: List tool runs within an agent conversation effect: read questions: - Which tools (studios) ran during a given agent conversation? - Can I page through the studio run history of one conversation? instructions: - text: List studio runs in conversation {conversation_id} of agent {agent_id}. slots: conversation_id: query.conversation_id agent_id: query.agent_id - text: Show the tool history for conversation {conversation_id}. slots: conversation_id: query.conversation_id method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/cancel'].post update: x-apievangelist-phrasing: intent: Stop a running agent effect: destructive questions: - How do I stop an agent that is currently running? - Can I cancel an in-progress agent job? instructions: - text: Cancel the running agent {agent_id}. slots: agent_id: path.agent_id - text: Stop agent {agent_id} now. slots: agent_id: path.agent_id method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/submit-message-feedback'].post update: x-apievangelist-phrasing: intent: Submit feedback on an agent message effect: write questions: - How do I give a thumbs up or down on a message an agent generated? - Can I leave feedback on a whole conversation rather than one message? instructions: - text: 'Mark message {message_id} in conversation {conversation_id} of agent {agent_id} as positive: {is_feedback_positive}, tags {task_tags}, details {task_details}.' slots: message_id: requestBody.message_id conversation_id: requestBody.conversation_id agent_id: path.agent_id is_feedback_positive: requestBody.is_feedback_positive task_tags: requestBody.task_tags task_details: requestBody.task_details - text: Add note {notes} as feedback on message {message_id} from agent {agent_id}. slots: notes: requestBody.notes message_id: requestBody.message_id agent_id: path.agent_id method: generated generated: '2026-09-26' - target: $.paths['/agents/analytics'].post update: x-apievangelist-phrasing: intent: Get time-series analytics for agents effect: read questions: - What does agent usage look like over time? - Can I filter agent time-series analytics? instructions: - text: Show time-series analytics for my agents. - text: Get agent analytics filtered by {filters}. slots: filters: requestBody.filters method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/batch-schedule-agent-tasks'].post update: x-apievangelist-phrasing: intent: Page through an agent's batch-scheduled tasks effect: read questions: - Can I see the tasks inside a batch schedule I set up for an agent? - Which items are in an agent's batch-scheduled task group? instructions: - text: Show batch-scheduled tasks for agent {agent_id} in knowledge set {knowledge_set}, document {sync_document_id}. slots: agent_id: path.agent_id knowledge_set: requestBody.knowledge_set sync_document_id: requestBody.sync_document_id - text: Page through agent {agent_id}'s batch schedule {sync_document_id} in set {knowledge_set}. slots: agent_id: path.agent_id sync_document_id: requestBody.sync_document_id knowledge_set: requestBody.knowledge_set method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/batch-schedule-agent-tasks/create'].post update: x-apievangelist-phrasing: intent: Batch-schedule tasks for an agent effect: write questions: - How do I schedule many tasks for one agent spread out over time? - Can I upload a CSV to fill a message template when batch-scheduling agent tasks? instructions: - text: Batch-schedule tasks for agent {agent_id} named {display_name} with template {message_template} and pacing {contract}. slots: agent_id: path.agent_id display_name: requestBody.display_name message_template: requestBody.message_template contract: requestBody.contract - text: Schedule agent {agent_id} tasks from CSV {csv} using template {message_template}, name {display_name}, pacing {contract}. slots: agent_id: path.agent_id csv: requestBody.csv message_template: requestBody.message_template display_name: requestBody.display_name contract: requestBody.contract method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/batch-schedule-agent-tasks/cancel'].post update: x-apievangelist-phrasing: intent: Cancel an agent's batch-scheduled tasks effect: destructive questions: - How do I cancel a batch of scheduled tasks for an agent? - Does cancelling a batch schedule also cancel its individual items? instructions: - text: Cancel batch schedules {sync_document_ids} for agent {agent_id}. slots: sync_document_ids: requestBody.sync_document_ids agent_id: path.agent_id - text: Cancel all items in agent {agent_id}'s batch group {sync_document_ids}. slots: agent_id: path.agent_id sync_document_ids: requestBody.sync_document_ids method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/batch-schedule-agent-tasks/pause'].post update: x-apievangelist-phrasing: intent: Pause an agent's batch-scheduled tasks effect: write questions: - Can I pause a batch of scheduled agent tasks and resume it later? - Is there a way to temporarily hold an agent's batch schedule? instructions: - text: Pause batch schedules {sync_document_ids} for agent {agent_id}. slots: sync_document_ids: requestBody.sync_document_ids agent_id: path.agent_id - text: Hold agent {agent_id}'s batch task group {sync_document_ids}. slots: agent_id: path.agent_id sync_document_ids: requestBody.sync_document_ids method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/batch-schedule-agent-tasks/resume'].post update: x-apievangelist-phrasing: intent: Resume an agent's paused batch-scheduled tasks effect: write questions: - How do I restart a paused batch of scheduled agent tasks? - Can a paused agent batch schedule pick up where it left off? instructions: - text: Resume batch schedules {sync_document_ids} for agent {agent_id}. slots: sync_document_ids: requestBody.sync_document_ids agent_id: path.agent_id - text: Unpause agent {agent_id}'s batch task group {sync_document_ids}. slots: agent_id: path.agent_id sync_document_ids: requestBody.sync_document_ids method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/tasks/{knowledge_set}/view'].post update: x-apievangelist-phrasing: intent: View messages in an agent task effect: read questions: - How do I read the messages of one agent task conversation? - Can I include debug details and metadata when viewing an agent task? instructions: - text: Show the task view for agent {agent_id}, task {knowledge_set}. slots: agent_id: path.agent_id knowledge_set: path.knowledge_set - text: View agent {agent_id} task {knowledge_set} with debug info, {page_size} messages per page. slots: agent_id: path.agent_id knowledge_set: path.knowledge_set page_size: requestBody.page_size method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/tasks/{knowledge_set}/trigger_message'].get update: x-apievangelist-phrasing: intent: Get the message that triggered an agent task effect: read questions: - What message kicked off a particular agent task? - Can I see the original trigger message for an agent conversation? instructions: - text: Get the trigger message for agent {agent_id}, task {knowledge_set}. slots: agent_id: path.agent_id knowledge_set: path.knowledge_set - text: Show what started task {knowledge_set} on agent {agent_id}. slots: knowledge_set: path.knowledge_set agent_id: path.agent_id method: generated generated: '2026-09-26' - target: $.paths['/agents/recallai/desktop-sdk-upload'].post update: x-apievangelist-phrasing: intent: Create a Recall.ai desktop recording upload effect: write questions: - How do I get an upload token for a Recall.ai desktop SDK meeting recording? - Can I pass a recording config when creating a Recall.ai desktop upload? instructions: - text: Create a Recall.ai desktop SDK upload. - text: Create a Recall.ai desktop upload with recording config {recording_config}. slots: recording_config: requestBody.recording_config method: generated generated: '2026-09-26' - target: $.paths['/agents/view/list'].post update: x-apievangelist-phrasing: intent: List agents in display view effect: read questions: - Can I get the lightweight display list of agents for a table view? - What sort orders does the agents display view accept? instructions: - text: Show the agents display view. - text: List agents for display sorted by {sort}. slots: sort: requestBody.sort method: generated generated: '2026-09-26' - target: $.paths['/agents/count'].get update: x-apievangelist-phrasing: intent: Count agents in the project effect: read questions: - How many agents are in my project? - Is there a quick total of agents without listing them? instructions: - text: Count the agents in this project. - text: Tell me the total number of agents. method: generated generated: '2026-09-26' - target: $.paths['/agents/conversations/bulk/approve'].post update: x-apievangelist-phrasing: intent: Bulk approve agent conversations effect: write questions: - Can I approve many pending agent conversations at once? - What do I need to bulk approve conversations waiting on human review? instructions: - text: Approve conversations {conversation_ids} for agent {agent_id}. slots: conversation_ids: requestBody.conversation_ids agent_id: requestBody.agent_id - text: Bulk approve agent {agent_id}'s pending conversations {conversation_ids}. slots: agent_id: requestBody.agent_id conversation_ids: requestBody.conversation_ids method: generated generated: '2026-09-26' - target: $.paths['/agents/conversations/bulk/reject'].post update: x-apievangelist-phrasing: intent: Bulk reject agent conversations effect: write questions: - Can I reject a batch of agent conversations awaiting approval? - Is there a bulk way to decline an agent's pending actions? instructions: - text: Reject conversations {conversation_ids} for agent {agent_id}. slots: conversation_ids: requestBody.conversation_ids agent_id: requestBody.agent_id - text: Bulk decline agent {agent_id}'s pending conversations {conversation_ids}. slots: agent_id: requestBody.agent_id conversation_ids: requestBody.conversation_ids method: generated generated: '2026-09-26' - target: $.paths['/agents/conversations/bulk/respond'].post update: x-apievangelist-phrasing: intent: Bulk respond to agent escalations effect: write questions: - How do I answer many agent escalations with the same reply? - Can I respond to several escalated conversations in one go? instructions: - text: Reply {response_text} to escalations {escalations} for agent {agent_id}. slots: response_text: requestBody.response_text escalations: requestBody.escalations agent_id: requestBody.agent_id - text: Bulk respond to agent {agent_id}'s escalations {escalations} with {response_text}. slots: agent_id: requestBody.agent_id escalations: requestBody.escalations response_text: requestBody.response_text method: generated generated: '2026-09-26' - target: $.paths['/agents/conversations/bulk/rerun'].post update: x-apievangelist-phrasing: intent: Bulk rerun agent conversations effect: write questions: - Can I rerun a set of agent conversations after changing the agent? - Is it possible to replay many conversations at once? instructions: - text: Rerun conversations {conversation_ids} for agent {agent_id}. slots: conversation_ids: requestBody.conversation_ids agent_id: requestBody.agent_id - text: Bulk rerun agent {agent_id}'s conversations. slots: agent_id: requestBody.agent_id method: generated generated: '2026-09-26' - target: $.paths['/agents/versions/{version_id}/get'].get update: x-apievangelist-phrasing: intent: Get one saved version of an agent effect: read questions: - How do I look at a specific saved version of an agent? - Can I fetch an agent version by its version ID? instructions: - text: Get agent version {version_id}. slots: version_id: path.version_id - text: Show the config stored in agent version {version_id}. slots: version_id: path.version_id method: generated generated: '2026-09-26' - target: $.paths['/agents/versions/list'].post update: x-apievangelist-phrasing: intent: List an agent's version history effect: read questions: - What versions exist for an agent? - Can I page through an agent's version history? instructions: - text: List versions of agent {agent_id}. slots: agent_id: requestBody.agent_id - text: Show {page_size} versions per page for agent {agent_id}. slots: page_size: requestBody.page_size agent_id: requestBody.agent_id method: generated generated: '2026-09-26' - target: $.paths['/agents/versions/upsert'].post update: x-apievangelist-phrasing: intent: Create or update an agent version record effect: write questions: - How do I create or edit a named version record for an agent? - Can I partially update an agent version's config? instructions: - text: Create or update a version of agent {agent_id} named {name}. slots: agent_id: requestBody.agent_id name: requestBody.name - text: Update agent version {version_id} of agent {agent_id} with description {description}. slots: version_id: requestBody.version_id agent_id: requestBody.agent_id description: requestBody.description method: generated generated: '2026-09-26' - target: $.paths['/agents/versions/restore'].post update: x-apievangelist-phrasing: intent: Restore an old agent version as the draft effect: write questions: - How do I roll an agent back to an earlier version? - What happens to the current draft when I restore an old agent version? instructions: - text: Restore agent version {version_id} as the current draft. slots: version_id: requestBody.version_id - text: Roll back to agent version {version_id}. slots: version_id: requestBody.version_id method: generated generated: '2026-09-26' - target: $.paths['/agents/versions/draft'].post update: x-apievangelist-phrasing: intent: Save agent changes as a draft version effect: write questions: - Can I save changes to an agent as a draft without making them live? - Does saving an agent draft overwrite an existing draft? instructions: - text: Save agent {agent_id} as a draft. slots: agent_id: requestBody.agent_id - text: Save a draft of agent {agent_id} with system prompt {system_prompt}. slots: agent_id: requestBody.agent_id system_prompt: requestBody.system_prompt method: generated generated: '2026-09-26' - target: $.paths['/agents/versions/publish'].post update: x-apievangelist-phrasing: intent: Publish an agent's draft as the active version effect: write questions: - How do I make my agent's draft version live? - Can I publish the current draft of an agent through the API? instructions: - text: Publish the draft of agent {agent_id}. slots: agent_id: requestBody.agent_id - text: Make agent {agent_id}'s draft the active version. slots: agent_id: requestBody.agent_id method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/generate-card-artwork'].post update: x-apievangelist-phrasing: intent: Generate pixel art card artwork for an agent effect: write questions: - Can AI generate pixel art card artwork for my agent? - Which Gemini models can I choose for generating agent card art? instructions: - text: Generate card artwork for agent {agent_id}. slots: agent_id: path.agent_id - text: Create pixel art for agent {agent_id} using image model {img_gen_gemini_model}. slots: agent_id: path.agent_id img_gen_gemini_model: requestBody.img_gen_gemini_model method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/pre-publish-checks'].get update: x-apievangelist-phrasing: intent: List an agent's pre-publish checks effect: read questions: - Which pre-publish checks must my agent pass, and what is their status? - Can I see eval results against thresholds before publishing an agent version? instructions: - text: List pre-publish checks for agent {agent_id}. slots: agent_id: path.agent_id - text: Show pre-publish check results for agent {agent_id}, version {version_id}. slots: agent_id: path.agent_id version_id: query.version_id method: generated generated: '2026-09-26' - target: $.paths['/folders/upsert'].post update: x-apievangelist-phrasing: intent: Create or update a folder effect: write questions: - How do I organize my agents into folders? - Can I nest a folder under a parent folder? instructions: - text: Create a folder named {name} of type {folder_type}. slots: name: requestBody.name folder_type: requestBody.folder_type - text: Rename folder {folder_id} to {name} under parent {parent_folder_id}, type {folder_type}. slots: folder_id: requestBody.folder_id name: requestBody.name parent_folder_id: requestBody.parent_folder_id folder_type: requestBody.folder_type method: generated generated: '2026-09-26' - target: $.paths['/folders/{folder_id}/delete'].delete update: x-apievangelist-phrasing: intent: Delete a folder effect: destructive questions: - How do I delete a folder I used for organizing agents? - Can I remove an empty agent folder? instructions: - text: Delete folder {folder_id}. slots: folder_id: path.folder_id - text: Remove the folder {folder_id}. slots: folder_id: path.folder_id method: generated generated: '2026-09-26' - target: $.paths['/agents/meeting/connection-details'].post update: x-apievangelist-phrasing: intent: Get LiveKit connection details for a meeting agent effect: read questions: - How do I connect to the LiveKit room for a meeting agent? - What connection details does a meeting agent conversation expose? instructions: - text: Get meeting connection details for agent {agent_id}, conversation {conversation_id}, project {project_id}. slots: agent_id: requestBody.agent_id conversation_id: requestBody.conversation_id project_id: requestBody.project_id - text: Fetch the LiveKit room details for meeting conversation {conversation_id} with agent {agent_id} in project {project_id}. slots: conversation_id: requestBody.conversation_id agent_id: requestBody.agent_id project_id: requestBody.project_id method: generated generated: '2026-09-26' - target: $.paths['/mcp/list'].post update: x-apievangelist-phrasing: intent: List tools on a remote MCP server effect: read questions: - What tools does a remote MCP server expose? - Can I preview an MCP server's tools by URL before connecting it? instructions: - text: List tools from the MCP server at {url}. slots: url: requestBody.url - text: Show tools for saved MCP server config {mcp_server_config_id}. slots: mcp_server_config_id: requestBody.mcp_server_config_id method: generated generated: '2026-09-26' - target: $.paths['/agents/tasks/{knowledge_set}/messages/{document_id}/generate'].post update: x-apievangelist-phrasing: intent: Generate markup for an agent task message effect: read questions: - Can I generate rendered markup for a message in an agent task? - Is it possible to regenerate how an agent message is displayed using prompts? instructions: - text: Generate markup for message {document_id} in task {knowledge_set}. slots: document_id: path.document_id knowledge_set: path.knowledge_set - text: Generate markup for message {document_id} in task {knowledge_set} using prompts {prompts}. slots: document_id: path.document_id knowledge_set: path.knowledge_set prompts: requestBody.prompts method: generated generated: '2026-09-26' - target: $.paths['/agents/tasks/{knowledge_set}/messages/{document_id}/generate'].patch update: x-apievangelist-phrasing: intent: Apply generated markup to an agent message effect: write questions: - How do I save generated markup back onto an agent task message? - What signature is needed to apply a generated agent message? instructions: - text: Apply generated content {content} of type {type} to message {document_id} in task {knowledge_set}, safe {is_safe}, signature {signature}. slots: content: requestBody.content type: requestBody.type document_id: path.document_id knowledge_set: path.knowledge_set is_safe: requestBody.is_safe signature: requestBody.signature - text: Apply the signed ({signature}) generated {type} markup {content} to message {document_id} of task {knowledge_set}, is_safe {is_safe}. slots: signature: requestBody.signature type: requestBody.type content: requestBody.content document_id: path.document_id knowledge_set: path.knowledge_set is_safe: requestBody.is_safe method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/tasks/{knowledge_set}/metadata'].get update: x-apievangelist-phrasing: intent: Get metadata for an agent conversation effect: read questions: - What metadata is stored on one agent conversation? - Can I get a streaming token along with an agent conversation's metadata? instructions: - text: Get metadata for agent {agent_id} conversation {knowledge_set}. slots: agent_id: path.agent_id knowledge_set: path.knowledge_set - text: Show agent {agent_id} conversation {knowledge_set} metadata with a streaming token. slots: agent_id: path.agent_id knowledge_set: path.knowledge_set method: generated generated: '2026-09-26' - target: $.paths['/mas/{mas_id}/scratchpad/options'].post update: x-apievangelist-phrasing: intent: List tools and scratchpad values for a multi-agent system effect: read questions: - Which tools are available to a multi-agent system and which scratchpad values are missing? - Can I check for stale scratchpad values in a multi-agent system? instructions: - text: List scratchpad options for multi-agent system {mas_id}. slots: mas_id: path.mas_id - text: Show missing scratchpad values for multi-agent system {mas_id} and agent {agent_id}. slots: mas_id: path.mas_id agent_id: requestBody.agent_id method: generated generated: '2026-09-26' - target: $.paths['/workforce/items/{document_id}'].get update: x-apievangelist-phrasing: intent: Get a workforce's configuration effect: read questions: - How do I fetch a workforce's graph and settings? - Can I retrieve a specific version of a workforce instead of the active one? instructions: - text: Get workforce {document_id}. slots: document_id: path.document_id - text: Retrieve workforce {document_id} at version {version}. slots: document_id: path.document_id version: query.version method: generated generated: '2026-09-26' - target: $.paths['/workforce/items/{document_id}'].post update: x-apievangelist-phrasing: intent: Save a workforce configuration effect: write questions: - How do I save changes to a workforce's graph of agents? - Can I save and publish a workforce in the same call? instructions: - text: Save workforce {document_id} with graph {workforce_graph}, metadata {workforce_metadata}, publish {should_publish}. slots: document_id: path.document_id workforce_graph: requestBody.workforce_graph workforce_metadata: requestBody.workforce_metadata should_publish: requestBody.should_publish - text: Update the workforce {document_id} graph to {workforce_graph} and metadata {workforce_metadata} without publishing ({should_publish}). slots: document_id: path.document_id workforce_graph: requestBody.workforce_graph workforce_metadata: requestBody.workforce_metadata should_publish: requestBody.should_publish method: generated generated: '2026-09-26' - target: $.paths['/workforce/items/{document_id}'].delete update: x-apievangelist-phrasing: intent: Delete a workforce and its versions effect: destructive questions: - How do I permanently delete a workforce? - Are a workforce's saved versions removed when I delete it? instructions: - text: Delete workforce {document_id}. slots: document_id: path.document_id - text: Remove workforce {document_id} and all its versions. slots: document_id: path.document_id method: generated generated: '2026-09-26' - target: $.paths['/workforce/items/public/{document_id}'].get update: x-apievangelist-phrasing: intent: Get a public workforce's active version effect: read questions: - Can I view a workforce that has been shared publicly? - What does the public view of a workforce return? instructions: - text: Get public workforce {document_id}. slots: document_id: path.document_id - text: Show public workforce {document_id} from project {project}. slots: document_id: path.document_id project: query.project method: generated generated: '2026-09-26' - target: $.paths['/workforce/duplicate'].post update: x-apievangelist-phrasing: intent: Duplicate a workforce from its published version effect: write questions: - Can I make a copy of a workforce based on its currently published version? - Does duplicating a workforce copy the draft or the published graph? instructions: - text: Duplicate the published version of workforce {workforce_id}. slots: workforce_id: requestBody.workforce_id - text: Make a copy of workforce {workforce_id} from what is published. slots: workforce_id: requestBody.workforce_id method: generated generated: '2026-09-26' - target: $.paths['/workforce/list'].post update: x-apievangelist-phrasing: intent: List workforces in the project effect: read questions: - Which workforces exist in my project? - Can I search workforces by name and include their nodes? instructions: - text: List the workforces in this project. - text: Search workforces for {searchQuery}. slots: searchQuery: query.searchQuery method: generated generated: '2026-09-26' - target: $.paths['/workforce/trigger'].post update: x-apievangelist-phrasing: intent: Run a workforce effect: write questions: - How do I kick off a workforce run through the API? - Can I continue an existing workforce task when triggering it? instructions: - text: Trigger workforce {workforce_id} with {trigger}. slots: workforce_id: requestBody.workforce_id trigger: requestBody.trigger - text: Run workforce {workforce_id} on task {workforce_task_id} with trigger {trigger}. slots: workforce_id: requestBody.workforce_id workforce_task_id: requestBody.workforce_task_id trigger: requestBody.trigger method: generated generated: '2026-09-26' - target: $.paths['/workforce/rerun'].post update: x-apievangelist-phrasing: intent: Rerun a workforce from a specific event effect: write questions: - Can I rerun a workforce task starting from a particular node event? - Is there a way to replay a workforce from midway instead of from the beginning? instructions: - text: Rerun workforce {workforce_id} task {workforce_task_id} from event {node_started_event_id}. slots: workforce_id: requestBody.workforce_id workforce_task_id: requestBody.workforce_task_id node_started_event_id: requestBody.node_started_event_id - text: Replay task {workforce_task_id} of workforce {workforce_id} starting at node event {node_started_event_id}. slots: workforce_task_id: requestBody.workforce_task_id workforce_id: requestBody.workforce_id node_started_event_id: requestBody.node_started_event_id method: generated generated: '2026-09-26' - target: $.paths['/workforce/tasks/list'].post update: x-apievangelist-phrasing: intent: List a workforce's tasks effect: read questions: - What tasks has a workforce run? - Can I search a workforce's tasks by text? instructions: - text: List tasks for workforce {workforce_id}. slots: workforce_id: requestBody.workforce_id - text: Search workforce {workforce_id} tasks for {query}. slots: workforce_id: requestBody.workforce_id query: requestBody.query method: generated generated: '2026-09-26' - target: $.paths['/workforce/items/{workforce_id}/tasks/{task_id}/messages'].post update: x-apievangelist-phrasing: intent: List messages in a workforce task effect: read questions: - How do I read the message thread of a workforce task? - Can I include debug metadata when listing workforce task messages? instructions: - text: List messages in task {task_id} of workforce {workforce_id}. slots: task_id: path.task_id workforce_id: path.workforce_id - text: Show {page_size} messages from workforce {workforce_id} task {task_id}. slots: page_size: requestBody.page_size workforce_id: path.workforce_id task_id: path.task_id method: generated generated: '2026-09-26' - target: $.paths['/workforce/items/{workforce_id}/tasks/{task_id}/state'].patch update: x-apievangelist-phrasing: intent: Change the state of a workforce task effect: write questions: - Can I change the state of a workforce task, for example to stop it? - What task states can I request for a workforce task? instructions: - text: Set workforce {workforce_id} task {task_id} to state {requested_state}. slots: workforce_id: path.workforce_id task_id: path.task_id requested_state: requestBody.requested_state - text: Move task {task_id} in workforce {workforce_id} to {requested_state}. slots: task_id: path.task_id workforce_id: path.workforce_id requested_state: requestBody.requested_state method: generated generated: '2026-09-26' - target: $.paths['/workforce/items/{workforce_id}/tasks/{task_id}/title'].patch update: x-apievangelist-phrasing: intent: Rename a workforce task effect: write questions: - How do I rename a workforce task? - Can I change the title shown for a workforce task? instructions: - text: Rename workforce {workforce_id} task {task_id} to {title}. slots: workforce_id: path.workforce_id task_id: path.task_id title: requestBody.title - text: Set the title of task {task_id} in workforce {workforce_id} to {title}. slots: task_id: path.task_id workforce_id: path.workforce_id title: requestBody.title method: generated generated: '2026-09-26' - target: $.paths['/workforce/tasks/delete'].post update: x-apievangelist-phrasing: intent: Delete workforce tasks effect: destructive questions: - Can I delete several workforce tasks at once? - How do I clear out old workforce tasks? instructions: - text: Delete workforce tasks {workforce_task_ids}. slots: workforce_task_ids: requestBody.workforce_task_ids - text: 'Remove these workforce tasks: {workforce_task_ids}.' slots: workforce_task_ids: requestBody.workforce_task_ids method: generated generated: '2026-09-26' - target: $.paths['/workforce/versions/list'].post update: x-apievangelist-phrasing: intent: List a workforce's version history effect: read questions: - What versions exist for a workforce? - Can I page through a workforce's version history? instructions: - text: List versions of workforce {workforce_id}. slots: workforce_id: requestBody.workforce_id - text: Show {page_size} versions per page for workforce {workforce_id}. slots: page_size: requestBody.page_size workforce_id: requestBody.workforce_id method: generated generated: '2026-09-26' - target: $.paths['/workforce/versions/upsert'].post update: x-apievangelist-phrasing: intent: Create or update a workforce version record effect: write questions: - How do I create or edit a named version of a workforce? - Can I partially update a workforce version's config? instructions: - text: Create or update a version of workforce {workforce_id} named {name}. slots: workforce_id: requestBody.workforce_id name: requestBody.name - text: Update workforce version {version_id} of workforce {workforce_id} with description {description}. slots: version_id: requestBody.version_id workforce_id: requestBody.workforce_id description: requestBody.description method: generated generated: '2026-09-26' - target: $.paths['/workforce/versions/restore'].post update: x-apievangelist-phrasing: intent: Restore an old workforce version as the draft effect: write questions: - How do I roll a workforce back to an earlier version? - What happens to the draft when I restore an old workforce version? instructions: - text: Restore workforce version {version_id} as the current draft. slots: version_id: requestBody.version_id - text: Roll the workforce back to version {version_id}. slots: version_id: requestBody.version_id method: generated generated: '2026-09-26' - target: $.paths['/workforce/clone'].post update: x-apievangelist-phrasing: intent: Clone a workforce from a source effect: write questions: - Can I clone a workforce from a source such as a template? - How do I create a new workforce by cloning another one? instructions: - text: Clone workforce from source {source}. slots: source: requestBody.source - text: Create a new workforce cloned from {source}. slots: source: requestBody.source method: generated generated: '2026-09-26' - target: $.paths['/workforce/set_entities_public'].post update: x-apievangelist-phrasing: intent: Make all agents and tools in a workforce public effect: write questions: - How do I make every agent and tool inside a workforce public? - Does making a workforce's entities public also cover subagents? instructions: - text: Set all agents and tools in workforce {workforce_id} to public. slots: workforce_id: requestBody.workforce_id - text: Publish every entity used by workforce {workforce_id} publicly. slots: workforce_id: requestBody.workforce_id method: generated generated: '2026-09-26' - target: $.paths['/workforce/{workforce_id}/scratchpad/options'].post update: x-apievangelist-phrasing: intent: List tool outputs available in a workforce effect: read questions: - What tool outputs can nodes in a workforce reference? - Can I list all outputs of all tools across a workforce's agents? instructions: - text: List scratchpad options for workforce {workforce_id}. slots: workforce_id: path.workforce_id - text: Show every tool output available in workforce {workforce_id}. slots: workforce_id: path.workforce_id method: generated generated: '2026-09-26' - target: $.paths['/workforce/tasks/{task_id}/metadata'].get update: x-apievangelist-phrasing: intent: Get metadata for a workforce conversation effect: read questions: - What metadata is stored on a workforce task conversation? - Can I get a streaming token with a workforce conversation's metadata? instructions: - text: Get metadata for workforce task {task_id}. slots: task_id: path.task_id - text: Show workforce conversation {task_id} metadata including a streaming token. slots: task_id: path.task_id method: generated generated: '2026-09-26' - target: $.paths['/workforce/{workforce_id}/streaming-token/{workforce_task_id}'].get update: x-apievangelist-phrasing: intent: Get a streaming token for a workforce task effect: read questions: - How do I open a stream for a workforce run before the task is created? - Where do I get a streaming token for a workforce task? instructions: - text: Get a streaming token for workforce {workforce_id}, task {workforce_task_id}. slots: workforce_id: path.workforce_id workforce_task_id: path.workforce_task_id - text: Fetch the stream token for task {workforce_task_id} on workforce {workforce_id}. slots: workforce_task_id: path.workforce_task_id workforce_id: path.workforce_id method: generated generated: '2026-09-26' - target: $.paths['/workforce/node/test'].post update: x-apievangelist-phrasing: intent: Test a single node in a workforce effect: write questions: - Can I test one node of a workforce without running the whole thing? - How do I run a single agent or tool node with sample params? instructions: - text: Test node {node_id} in workforce {workforce_id}. slots: node_id: requestBody.node_id workforce_id: requestBody.workforce_id - text: Run node {node_id} of workforce {workforce_id} with message {message}. slots: node_id: requestBody.node_id workforce_id: requestBody.workforce_id message: requestBody.message method: generated generated: '2026-09-26' - target: $.paths['/workforce/get_embed_key'].post update: x-apievangelist-phrasing: intent: Get an embed key for a workforce effect: write questions: - How do I get a key to embed a workforce publicly? - Where does a workforce's embed key come from? instructions: - text: Generate an embed key for workforce {workforce_id} in project {project}. slots: workforce_id: requestBody.workforce_id project: requestBody.project - text: Give me the public embed key for workforce {workforce_id}, project {project}. slots: workforce_id: requestBody.workforce_id project: requestBody.project method: generated generated: '2026-09-26' - target: $.paths['/workforce/count'].get update: x-apievangelist-phrasing: intent: Count workforces in the project effect: read questions: - How many workforces does my project have? - Is there a quick total of workforces? instructions: - text: Count the workforces in this project. - text: Tell me the total number of workforces. method: generated generated: '2026-09-26' - target: $.paths['/sync/template'].post update: x-apievangelist-phrasing: intent: Create or update a sync template effect: write questions: - What is a sync template and how do I create one with shared settings? - Can I update an existing sync template's config by its ID? instructions: - text: Create a sync template of type {type} with config {config}. slots: type: requestBody.type config: requestBody.config - text: Update sync template {sync_template_id} of type {type} to config {config}. slots: sync_template_id: requestBody.sync_template_id type: requestBody.type config: requestBody.config method: generated generated: '2026-09-26' - target: $.paths['/triggers/{trigger_group_id}/summary'].get update: x-apievangelist-phrasing: intent: Get a trigger group's progress summary effect: read questions: - How far along is a trigger group and how is it configured? - Can I check progress on one specific trigger group? instructions: - text: Summarize trigger group {trigger_group_id}. slots: trigger_group_id: path.trigger_group_id - text: Show progress for trigger group {trigger_group_id}. slots: trigger_group_id: path.trigger_group_id method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/triggers/summaries'].post update: x-apievangelist-phrasing: intent: List trigger group summaries for an agent effect: read questions: - What trigger groups does a given agent have? - Can I filter an agent's trigger groups by type or status? instructions: - text: List trigger group summaries for agent {agent_id} from cursor {cursor}. slots: agent_id: path.agent_id cursor: requestBody.cursor - text: Show agent {agent_id} trigger groups with status {statuses}, cursor {cursor}. slots: agent_id: path.agent_id statuses: requestBody.statuses cursor: requestBody.cursor method: generated generated: '2026-09-26' - target: $.paths['/triggers/summaries'].post update: x-apievangelist-phrasing: intent: List trigger group summaries for a destination effect: read questions: - Which trigger groups point at a given destination? - Can I filter trigger group summaries by destination and status? instructions: - text: List trigger group summaries for destination {destination} from cursor {cursor}. slots: destination: requestBody.destination cursor: requestBody.cursor - text: Show trigger groups of type {trigger_types} targeting destination {destination}, cursor {cursor}. slots: trigger_types: requestBody.trigger_types destination: requestBody.destination cursor: requestBody.cursor method: generated generated: '2026-09-26' - target: $.paths['/agents/{agent_id}/active_triggers/overview'].post update: x-apievangelist-phrasing: intent: Overview of an agent's active trigger groups effect: read questions: - Which trigger groups are currently active for an agent? - Is there an overview of live triggers on one agent? instructions: - text: Show the active trigger overview for agent {agent_id}. slots: agent_id: path.agent_id - text: List the triggers currently live on agent {agent_id}. slots: agent_id: path.agent_id method: generated generated: '2026-09-26' - target: $.paths['/triggers/active/overview'].post update: x-apievangelist-phrasing: intent: Overview of active trigger groups for a destination effect: read questions: - Which trigger groups are active for a particular destination? - Can I see live triggers by destination rather than by agent? instructions: - text: Show the active trigger overview for destination {destination}. slots: destination: requestBody.destination - text: Get active trigger groups targeting destination {destination}. slots: destination: requestBody.destination method: generated generated: '2026-09-26' - target: $.paths['/trigger/items/view'].post update: x-apievangelist-phrasing: intent: List items in a trigger group effect: read questions: - What individual items are inside a trigger group? - Can I filter a trigger group's items by simplified status? instructions: - text: List items in trigger group {trigger_group_id} with status {simplified_status} from cursor {cursor}. slots: trigger_group_id: requestBody.trigger_group_id simplified_status: requestBody.simplified_status cursor: requestBody.cursor - text: Show {page_size} {simplified_status} items for trigger group {trigger_group_id}, cursor {cursor}. slots: page_size: requestBody.page_size simplified_status: requestBody.simplified_status trigger_group_id: requestBody.trigger_group_id cursor: requestBody.cursor method: generated generated: '2026-09-26' - target: $.paths['/triggers/update_status'].post update: x-apievangelist-phrasing: intent: Change a trigger group's status effect: write questions: - How do I change the status of a trigger group? - Can I switch a trigger group on or off by status? instructions: - text: Set trigger group {trigger_group_id} status to {status}. slots: trigger_group_id: requestBody.trigger_group_id status: requestBody.status - text: Update the status of trigger group {trigger_group_id} to {status}. slots: trigger_group_id: requestBody.trigger_group_id status: requestBody.status method: generated generated: '2026-09-26' - target: $.paths['/triggers/bulk_cancel'].post update: x-apievangelist-phrasing: intent: Cancel all upcoming items in a trigger group effect: destructive questions: - Can I cancel every upcoming item in a trigger group at once? - How do I stop all pending scheduled items for a trigger group? instructions: - text: Cancel all upcoming items in trigger group {trigger_group_id}. slots: trigger_group_id: requestBody.trigger_group_id - text: Bulk cancel pending sync items for trigger group {trigger_group_id}. slots: trigger_group_id: requestBody.trigger_group_id method: generated generated: '2026-09-26' - target: $.paths['/sync-items/collections/{collection_id}/bulk/update_status'].post update: x-apievangelist-phrasing: intent: Bulk update sync item statuses in a collection effect: write questions: - Can I change the status of many sync items in a collection at once? - Does a bulk status update apply to every item matching my filters? instructions: - text: Update sync items in collection {collection_id} matching {filters} with {update}. slots: collection_id: path.collection_id filters: requestBody.filters update: requestBody.update - text: Apply status change {update} to items in collection {collection_id} filtered by {filters}. slots: update: requestBody.update collection_id: path.collection_id filters: requestBody.filters method: generated generated: '2026-09-26' - target: $.paths['/batch-schedule-tasks/create'].post update: x-apievangelist-phrasing: intent: Batch-schedule tasks for a destination effect: write questions: - How do I schedule a batch of tasks for any destination, not just one agent? - Can I pace a batch of tasks over time from a CSV? instructions: - text: Batch-schedule tasks named {display_name} to destination {destination} with template {message_template} and pacing {contract}. slots: display_name: requestBody.display_name destination: requestBody.destination message_template: requestBody.message_template contract: requestBody.contract - text: Schedule tasks from CSV {csv} to destination {destination} using {message_template}, name {display_name}, pacing {contract}. slots: csv: requestBody.csv destination: requestBody.destination message_template: requestBody.message_template display_name: requestBody.display_name contract: requestBody.contract method: generated generated: '2026-09-26' - target: $.paths['/trigger/pull/test'].post update: x-apievangelist-phrasing: intent: Fetch sample data to test a trigger effect: read questions: - Can I pull the latest data a trigger would receive to test it? - How do I preview trigger data before turning a trigger on? instructions: - text: Pull test data for trigger config {sync_config}. slots: sync_config: requestBody.sync_config - text: Fetch the latest trigger data for {sync_config}. slots: sync_config: requestBody.sync_config method: generated generated: '2026-09-26' - target: $.paths['/chats/agents'].get update: x-apievangelist-phrasing: intent: List agents visible in the chat app effect: read questions: - Which agents show up in the chat app? - Can I search the agents available to chat with? instructions: - text: List agents available in chat. - text: Search chat agents for {query}. slots: query: query.query method: generated generated: '2026-09-26' - target: $.paths['/chats/settings'].get update: x-apievangelist-phrasing: intent: Get my chat settings effect: read questions: - What are my personal chat settings? - Where can I see my own chat preferences? instructions: - text: Get my chat settings. - text: Show my personal chat preferences. method: generated generated: '2026-09-26' - target: $.paths['/chats/settings'].post update: x-apievangelist-phrasing: intent: Update my chat settings effect: write questions: - How do I change my personal chat settings? - Can I update my own chat preferences without affecting the project? instructions: - text: Update my chat settings to {settings}. slots: settings: requestBody.settings - text: Change my personal chat preferences to {settings}. slots: settings: requestBody.settings method: generated generated: '2026-09-26' - target: $.paths['/chats/project-settings'].get update: x-apievangelist-phrasing: intent: Get project-level chat settings effect: read questions: - What chat settings apply to the whole project? - Can I view the project-wide chat configuration? instructions: - text: Get the project chat settings. - text: Show project-wide chat configuration. method: generated generated: '2026-09-26' - target: $.paths['/chats/project-settings'].post update: x-apievangelist-phrasing: intent: Update project-level chat settings effect: write questions: - How does an admin change chat settings for the whole project? - Can I hide agents from chat for everyone in the project? instructions: - text: Update the project chat settings to {settings}. slots: settings: requestBody.settings - text: Set project-wide chat configuration to {settings}. slots: settings: requestBody.settings method: generated generated: '2026-09-26' - target: $.paths['/chats/settings/configurable-tool-permissions'].get update: x-apievangelist-phrasing: intent: List tool actions with configurable permissions effect: read questions: - Which tool actions can I set permission rules for in chat? - What tool permissions are configurable? instructions: - text: List configurable tool permissions. - text: Show tool actions I can set permission rules on. method: generated generated: '2026-09-26' - target: $.paths['/chats/settings/available-options'].get update: x-apievangelist-phrasing: intent: List mounts and skills available in chat effect: read questions: - What mounts and skills can I toggle on or off in chat? - Can I search the skills available for chat? instructions: - text: List the mounts and skills I can toggle in chat. - text: Search chat skills for {skills_query}. slots: skills_query: query.skills_query method: generated generated: '2026-09-26' - target: $.paths['/chats/missing-inputs'].post update: x-apievangelist-phrasing: intent: Check missing inputs before a workforce chat effect: read questions: - Which manual inputs does a workforce chat need before I trigger it? - Can I check whether a chat message is missing required tool inputs? instructions: - text: Check missing inputs for chat message {message}. slots: message: requestBody.message - text: List required inputs missing for message {message} in chat {workforce_task_id}. slots: message: requestBody.message workforce_task_id: requestBody.workforce_task_id method: generated generated: '2026-09-26' - target: $.paths['/chats/prerequisites'].post update: x-apievangelist-phrasing: intent: Check inputs and MCP auth before a workforce chat effect: read questions: - Can I check both missing inputs and MCP authentication before starting a chat? - What prerequisites must be satisfied before a workforce chat runs? instructions: - text: Check chat prerequisites, including MCP auth, before triggering. - text: Check prerequisites and MCP auth for message {message} in chat {workforce_task_id}. slots: message: requestBody.message workforce_task_id: requestBody.workforce_task_id method: generated generated: '2026-09-26' - target: $.paths['/chats/trigger'].post update: x-apievangelist-phrasing: intent: Send a message in a chat effect: write questions: - How do I start or continue a chat through the API? - Can I apply a branding kit when triggering a chat? instructions: - text: Start a chat with {trigger}. slots: trigger: requestBody.trigger - text: Send {trigger} in chat {workforce_task_id}. slots: trigger: requestBody.trigger workforce_task_id: requestBody.workforce_task_id - text: Trigger a chat with {trigger} using branding kit {branding_kit_id}. slots: trigger: requestBody.trigger branding_kit_id: requestBody.branding_kit_id method: generated generated: '2026-09-26' - target: $.paths['/chats/{workforce_task_id}/get'].get update: x-apievangelist-phrasing: intent: Get a single chat effect: read questions: - How do I fetch one chat by its ID? - Can I get a streaming token together with a chat? instructions: - text: Get chat {workforce_task_id}. slots: workforce_task_id: path.workforce_task_id - text: Open chat {workforce_task_id} with a streaming token. slots: workforce_task_id: path.workforce_task_id method: generated generated: '2026-09-26' - target: $.paths['/chats'].get update: x-apievangelist-phrasing: intent: List chats effect: read questions: - Which chats have I had? - Can I search or filter my chats by tag? instructions: - text: List my chats. - text: Search my chats for {query}. slots: query: query.query - text: Show chats tagged {tags}. slots: tags: query.tags method: generated generated: '2026-09-26' - target: $.paths['/chats/update'].post update: x-apievangelist-phrasing: intent: Update a chat's model or agents effect: write questions: - Can I switch the model used in an existing chat? - How do I remove agents from a chat? instructions: - text: Switch chat {workforce_task_id} to model {chat_model}. slots: workforce_task_id: requestBody.workforce_task_id chat_model: requestBody.chat_model - text: Remove agents {remove_agent_ids} from chat {workforce_task_id}. slots: remove_agent_ids: requestBody.remove_agent_ids workforce_task_id: requestBody.workforce_task_id method: generated generated: '2026-09-26' - target: $.paths['/chats/delete'].post update: x-apievangelist-phrasing: intent: Delete a chat effect: destructive questions: - How do I delete a chat? - Can I permanently remove a chat from my history? instructions: - text: Delete chat {workforce_task_id}. slots: workforce_task_id: requestBody.workforce_task_id - text: Remove chat {workforce_task_id} from my history. slots: workforce_task_id: requestBody.workforce_task_id method: generated generated: '2026-09-26' - target: $.paths['/chats/{task_id}/credit-usage'].get update: x-apievangelist-phrasing: intent: Get credits used by a chat effect: read questions: - How many credits has a chat used? - Can I see the total credit cost of one chat task? instructions: - text: Get credit usage for chat {task_id}. slots: task_id: path.task_id - text: Show how many credits chat {task_id} consumed. slots: task_id: path.task_id method: generated generated: '2026-09-26' - target: $.paths['/preset_agents'].get update: x-apievangelist-phrasing: intent: List preset agent templates effect: read questions: - What preset agents are available to set up? - Can I search the preset agent catalog? instructions: - text: List preset agents. - text: Search preset agents for {query}. slots: query: query.query method: generated generated: '2026-09-26' - target: $.paths['/beta/chat/super-agent/tasks'].get update: x-apievangelist-phrasing: intent: Get super agent chat tasks in a time range effect: read questions: - Can I pull super agent chat tasks between two dates? - Which super agent chat tasks ran in a given period? instructions: - text: Get super agent chat tasks from {start_datetime} to {end_datetime}. slots: start_datetime: query.start_datetime end_datetime: query.end_datetime - text: List super agent chat tasks since {start_datetime}. slots: start_datetime: query.start_datetime method: generated generated: '2026-09-26' - target: $.paths['/beta/chat/super-agent/files'].get update: x-apievangelist-phrasing: intent: Get super agent chat files in a time range effect: read questions: - Can I pull files produced in super agent chats between two dates? - Which super agent chat files were created in a given period? instructions: - text: Get super agent chat files from {start_datetime} to {end_datetime}. slots: start_datetime: query.start_datetime end_datetime: query.end_datetime - text: List super agent chat files since {start_datetime}. slots: start_datetime: query.start_datetime method: generated generated: '2026-09-26' - target: $.paths['/saved_prompts'].get update: x-apievangelist-phrasing: intent: List saved prompts effect: read questions: - What saved prompts does my project have? - Can I page through the project's saved prompts? instructions: - text: List saved prompts. - text: Show page {page} of saved prompts. slots: page: query.page method: generated generated: '2026-09-26' - target: $.paths['/saved_prompts'].post update: x-apievangelist-phrasing: intent: Save a new prompt effect: write questions: - How do I save a prompt I reuse often? - Can I share a saved prompt with the rest of my project? instructions: - text: Save prompt {prompt} as {name}. slots: prompt: requestBody.prompt name: requestBody.name - text: Create shared saved prompt {name} with text {prompt}. slots: name: requestBody.name prompt: requestBody.prompt method: generated generated: '2026-09-26' - target: $.paths['/saved_prompts/{saved_prompt_id}/update'].post update: x-apievangelist-phrasing: intent: Update a saved prompt effect: write questions: - How do I edit the text of an existing saved prompt? - Can I stop sharing a saved prompt? instructions: - text: Change saved prompt {saved_prompt_id} text to {prompt}. slots: saved_prompt_id: path.saved_prompt_id prompt: requestBody.prompt - text: Rename saved prompt {saved_prompt_id} to {name}. slots: saved_prompt_id: path.saved_prompt_id name: requestBody.name method: generated generated: '2026-09-26' - target: $.paths['/saved_prompts/{saved_prompt_id}/delete'].post update: x-apievangelist-phrasing: intent: Delete a saved prompt effect: destructive questions: - How do I delete a saved prompt? - Can I remove a prompt I no longer use? instructions: - text: Delete saved prompt {saved_prompt_id}. slots: saved_prompt_id: path.saved_prompt_id - text: Remove the saved prompt {saved_prompt_id}. slots: saved_prompt_id: path.saved_prompt_id method: generated generated: '2026-09-26' - target: $.paths['/slide_show'].get update: x-apievangelist-phrasing: intent: List my slideshows effect: read questions: - Which slideshows have I made? - Can I page through my slideshows with a preview of the first slide? instructions: - text: List my slideshows. - text: Show page {page} of my slideshows. slots: page: query.page method: generated generated: '2026-09-26' - target: $.paths['/slide_show'].post update: x-apievangelist-phrasing: intent: Create a standalone slideshow effect: write questions: - How do I create a new slideshow outside of a chat? - Can I set the slide order when creating a slideshow? instructions: - text: Create a new slideshow. - text: Create a slideshow with content {content} in order {order}. slots: content: requestBody.content order: requestBody.order method: generated generated: '2026-09-26' - target: $.paths['/chats/{task_id}/slide_show'].get update: x-apievangelist-phrasing: intent: Get the slideshow for a chat effect: read questions: - Can I get the slideshow a chat produced? - Where do I find the deck generated in a particular chat? instructions: - text: Get the slideshow for chat {task_id}. slots: task_id: path.task_id - text: Show the slides generated in chat {task_id}. slots: task_id: path.task_id method: generated generated: '2026-09-26' - target: $.paths['/slide_show/{slideshow_id}'].get update: x-apievangelist-phrasing: intent: Get a slideshow by ID effect: read questions: - How do I fetch a slideshow by its slideshow ID? - What does a slideshow record contain? instructions: - text: Get slideshow {slideshow_id}. slots: slideshow_id: path.slideshow_id - text: Open slideshow {slideshow_id}. slots: slideshow_id: path.slideshow_id method: generated generated: '2026-09-26' - target: $.paths['/slide_show/{slideshow_id}/visibility'].patch update: x-apievangelist-phrasing: intent: Make a slideshow public or private effect: write questions: - Can I make a slideshow public so others can view it? - How do I set a slideshow back to private? instructions: - text: Set slideshow {slideshow_id} public to {public}. slots: slideshow_id: path.slideshow_id public: requestBody.public - text: Change the visibility of slideshow {slideshow_id} to public={public}. slots: slideshow_id: path.slideshow_id public: requestBody.public method: generated generated: '2026-09-26' - target: $.paths['/slide_show_template/{slideshow_template_id}'].delete update: x-apievangelist-phrasing: intent: Delete a slideshow template effect: destructive questions: - How do I delete a slideshow template? - Can I remove a template I made from a slideshow? instructions: - text: Delete slideshow template {slideshow_template_id}. slots: slideshow_template_id: path.slideshow_template_id - text: Remove the slideshow template {slideshow_template_id}. slots: slideshow_template_id: path.slideshow_template_id method: generated generated: '2026-09-26' - target: $.paths['/slide_show_template/{slideshow_template_id}'].patch update: x-apievangelist-phrasing: intent: Rename a slideshow template effect: write questions: - Can I rename a slideshow template? - What can I change on a slideshow template after creating it? instructions: - text: Rename slideshow template {slideshow_template_id} to {name}. slots: slideshow_template_id: path.slideshow_template_id name: requestBody.name - text: Set the name of template {slideshow_template_id} to {name}. slots: slideshow_template_id: path.slideshow_template_id name: requestBody.name method: generated generated: '2026-09-26' - target: $.paths['/slide_show/{slideshow_id}/export'].post update: x-apievangelist-phrasing: intent: Export a slideshow as PDF or PNG effect: read questions: - Can I export a slideshow as a PDF? - Is it possible to export only certain slides as PNG images? instructions: - text: Export slideshow {slideshow_id} as {type}. slots: slideshow_id: path.slideshow_id type: requestBody.type - text: Export slides {slide_ids} of slideshow {slideshow_id} as {type}. slots: slide_ids: requestBody.slide_ids slideshow_id: path.slideshow_id type: requestBody.type method: generated generated: '2026-09-26' - target: $.paths['/slide_show/{slideshow_id}/reorder'].post update: x-apievangelist-phrasing: intent: Reorder slides in a slideshow effect: write questions: - How do I change the order of slides in a deck? - Can I move slides around in an existing slideshow? instructions: - text: Reorder slideshow {slideshow_id} to {slide_order}. slots: slideshow_id: path.slideshow_id slide_order: requestBody.slide_order - text: Put the slides of {slideshow_id} in order {slide_order}. slots: slideshow_id: path.slideshow_id slide_order: requestBody.slide_order method: generated generated: '2026-09-26' - target: $.paths['/slide_show_template'].get update: x-apievangelist-phrasing: intent: List slideshow templates effect: read questions: - What slideshow templates are available? - Which deck templates can I start from? instructions: - text: List slideshow templates. - text: Show all available deck templates. method: generated generated: '2026-09-26' - target: $.paths['/slide_show_template'].post update: x-apievangelist-phrasing: intent: Create a template from a slideshow effect: write questions: - Can I turn an existing slideshow into a reusable template? - How do I save a deck as a template with a name? instructions: - text: Create a template from slideshow {slideshow_id}. slots: slideshow_id: requestBody.slideshow_id - text: Save slideshow {slideshow_id} as template {name}. slots: slideshow_id: requestBody.slideshow_id name: requestBody.name method: generated generated: '2026-09-26' - target: $.paths['/slide_show/{slideshow_id}/screenshot'].post update: x-apievangelist-phrasing: intent: Screenshot a slide effect: read questions: - Can I get a screenshot image of a single slide? - How do I capture one slide from a slideshow as an image? instructions: - text: Screenshot slide {slide_id} of slideshow {slideshow_id}. slots: slide_id: requestBody.slide_id slideshow_id: path.slideshow_id - text: Capture an image of slide {slide_id} in {slideshow_id}. slots: slide_id: requestBody.slide_id slideshow_id: path.slideshow_id method: generated generated: '2026-09-26' - target: $.paths['/slide_show_template/{slideshow_template_id}/content'].get update: x-apievangelist-phrasing: intent: Get the slides in a slideshow template effect: read questions: - What slides are inside a slideshow template? - Can I read a template's full content before using it? instructions: - text: Get the content of slideshow template {slideshow_template_id}. slots: slideshow_template_id: path.slideshow_template_id - text: Show all slides in template {slideshow_template_id}. slots: slideshow_template_id: path.slideshow_template_id method: generated generated: '2026-09-26' - target: $.paths['/slide_show/{slideshow_id}/versions'].get update: x-apievangelist-phrasing: intent: List a slideshow's versions effect: read questions: - What earlier versions of a slideshow are saved? - Can I see a slideshow's version history? instructions: - text: List versions of slideshow {slideshow_id}. slots: slideshow_id: path.slideshow_id - text: Show the version history for deck {slideshow_id}. slots: slideshow_id: path.slideshow_id method: generated generated: '2026-09-26' - target: $.paths['/slide_show/{slideshow_id}/versions/{version_id}'].get update: x-apievangelist-phrasing: intent: Get one version of a slideshow effect: read questions: - How do I view a specific past version of a slideshow? - Can I read what a deck looked like at an earlier version? instructions: - text: Get version {version_id} of slideshow {slideshow_id}. slots: version_id: path.version_id slideshow_id: path.slideshow_id - text: Show slideshow {slideshow_id} as of version {version_id}. slots: slideshow_id: path.slideshow_id version_id: path.version_id method: generated generated: '2026-09-26' - target: $.paths['/slide_show/{slideshow_id}/versions/{version_id}/restore'].post update: x-apievangelist-phrasing: intent: Restore a slideshow to an earlier version effect: write questions: - Can I roll a slideshow back to a previous version? - How do I undo slide changes by restoring an older version? instructions: - text: Restore slideshow {slideshow_id} to version {version_id}. slots: slideshow_id: path.slideshow_id version_id: path.version_id - text: Roll deck {slideshow_id} back to version {version_id}. slots: slideshow_id: path.slideshow_id version_id: path.version_id method: generated generated: '2026-09-26' - target: $.paths['/oembed'].get update: x-apievangelist-phrasing: intent: Get oEmbed data for a presentation URL effect: read questions: - How do I embed a slideshow on another site using oEmbed? - Can I set a maximum width and height for the oEmbed response? instructions: - text: Get oEmbed JSON for presentation {url}. slots: url: query.url - text: Get oEmbed for {url} with max width {maxwidth} and max height {maxheight}. slots: url: query.url maxwidth: query.maxwidth maxheight: query.maxheight method: generated generated: '2026-09-26' - target: $.paths['/slide/{slideshow_id}/chats'].get update: x-apievangelist-phrasing: intent: Get recent chats for a slideshow effect: read questions: - Which chats have worked on a particular slideshow recently? - Can I filter a slideshow's chats by status? instructions: - text: Get recent chats for slideshow {slideshow_id}. slots: slideshow_id: path.slideshow_id - text: Show chats with status {statuses} on slideshow {slideshow_id}. slots: statuses: query.statuses slideshow_id: path.slideshow_id method: generated generated: '2026-09-26' - target: $.paths['/csp_report'].post update: x-apievangelist-phrasing: intent: Report a Content Security Policy violation effect: write questions: - Where are browser CSP violation reports sent? - What fields does a report-only CSP violation need? instructions: - text: Log a CSP violation for directive {effectiveDirective} with disposition {disposition}. slots: effectiveDirective: requestBody.effectiveDirective disposition: requestBody.disposition - text: Report blocked URL {blockedURL} under directive {effectiveDirective}, disposition {disposition}. slots: blockedURL: requestBody.blockedURL effectiveDirective: requestBody.effectiveDirective disposition: requestBody.disposition method: generated generated: '2026-09-26' - target: $.paths['/conversations/{conversation_id}/files/list'].get update: x-apievangelist-phrasing: intent: List files in a conversation effect: read questions: - Which files are attached to a conversation? - Can I see every file created in one conversation? instructions: - text: List files in conversation {conversation_id}. slots: conversation_id: path.conversation_id - text: Show the files for conversation {conversation_id}. slots: conversation_id: path.conversation_id method: generated generated: '2026-09-26' - target: $.paths['/conversations/{conversation_id}/files/create'].post update: x-apievangelist-phrasing: intent: Add a file to a conversation effect: write questions: - How do I add a file to a conversation? - Can a conversation file be set to expire? instructions: - text: Create file {name} in conversation {conversation_id}, inferring the extension from {infer_extension_url}. slots: name: requestBody.name conversation_id: path.conversation_id infer_extension_url: requestBody.infer_extension_url - text: Add file {name} to conversation {conversation_id} from {infer_extension_url}, expiring after {expires_after}. slots: name: requestBody.name conversation_id: path.conversation_id infer_extension_url: requestBody.infer_extension_url expires_after: requestBody.expires_after method: generated generated: '2026-09-26' - target: $.paths['/conversations/{conversation_id}/files/{file_id}/get_upload_url'].get update: x-apievangelist-phrasing: intent: Get an upload URL for a conversation file effect: read questions: - How do I get a temporary URL to upload content for a conversation file? - Where do I send the bytes for a file I added to a conversation? instructions: - text: Get an upload URL for file {file_id} in conversation {conversation_id}. slots: file_id: path.file_id conversation_id: path.conversation_id - text: Give me a temporary upload link for conversation {conversation_id} file {file_id}. slots: conversation_id: path.conversation_id file_id: path.file_id method: generated generated: '2026-09-26' - target: $.paths['/tasks/{workforce_task_id}/files/{file_id}/get_download_url'].get update: x-apievangelist-phrasing: intent: Get a download URL for a task file effect: read questions: - How do I download a file produced by a workforce task? - Can I get a temporary download link for a task file? instructions: - text: Get a download URL for file {file_id} in task {workforce_task_id}. slots: file_id: path.file_id workforce_task_id: path.workforce_task_id - text: Give me a temporary download link for task {workforce_task_id} file {file_id}. slots: workforce_task_id: path.workforce_task_id file_id: path.file_id method: generated generated: '2026-09-26' - target: $.paths['/tasks/{workforce_task_id}/files/{file_id}/contents'].get update: x-apievangelist-phrasing: intent: Read a small task file's contents effect: read questions: - Can I read the text contents of a workforce task file directly? - What size limit applies when reading a task file's contents? instructions: - text: Read the contents of file {file_id} in task {workforce_task_id}. slots: file_id: path.file_id workforce_task_id: path.workforce_task_id - text: Show me what task {workforce_task_id} file {file_id} contains. slots: workforce_task_id: path.workforce_task_id file_id: path.file_id method: generated generated: '2026-09-26' - target: $.paths['/tasks/{workforce_task_id}/files/{file_id}/contents'].put update: x-apievangelist-phrasing: intent: Overwrite a task session file's contents effect: write questions: - Can I edit the contents of a workforce task session file? - Which task files can be overwritten, and how large can they be? instructions: - text: Replace the contents of file {file_id} in task {workforce_task_id} with {content}. slots: file_id: path.file_id workforce_task_id: path.workforce_task_id content: requestBody.content - text: Write {content} into task {workforce_task_id} session file {file_id}. slots: content: requestBody.content workforce_task_id: path.workforce_task_id file_id: path.file_id method: generated generated: '2026-09-26' - target: $.paths['/files'].post update: x-apievangelist-phrasing: intent: Start a file upload and get a presigned URL effect: write questions: - How do I start uploading a file and get a presigned URL? - What details must I declare before uploading a file? instructions: - text: Start uploading {filename} ({mime_type}, {size_bytes} bytes) from {upload_source}. slots: filename: requestBody.filename mime_type: requestBody.mime_type size_bytes: requestBody.size_bytes upload_source: requestBody.upload_source - text: Get a presigned upload URL for {filename} of type {mime_type}, size {size_bytes}, source {upload_source}. slots: filename: requestBody.filename mime_type: requestBody.mime_type size_bytes: requestBody.size_bytes upload_source: requestBody.upload_source method: generated generated: '2026-09-26' - target: $.paths['/files/{file_id}/confirm'].post update: x-apievangelist-phrasing: intent: Confirm a file upload finished effect: write questions: - What do I call after my file finishes uploading to the presigned URL? - Do I need to confirm an upload before the file can be used? instructions: - text: Confirm upload of file {file_id}. slots: file_id: path.file_id - text: Mark file {file_id} as uploaded. slots: file_id: path.file_id method: generated generated: '2026-09-26' - target: $.paths['/voice/token'].get update: x-apievangelist-phrasing: intent: Get a real-time voice transcription token effect: read questions: - How do I get a token for real-time voice input streaming? - Where does the temporary AssemblyAI streaming token come from? instructions: - text: Get a voice streaming token. - text: Issue a temporary AssemblyAI token for live voice input. method: generated generated: '2026-09-26' - target: $.paths['/fs/volumes'].get update: x-apievangelist-phrasing: intent: Discover available filesystem volumes effect: read questions: - Which filesystem volumes can I access? - Can I see the volumes available for a particular conversation? instructions: - text: List available filesystem volumes. - text: Discover volumes for conversation {conversation_id}. slots: conversation_id: query.conversation_id method: generated generated: '2026-09-26' - target: $.paths['/fs/list'].get update: x-apievangelist-phrasing: intent: List files and folders in a volume effect: read questions: - What files are in a folder on a volume? - Can I list a volume directory recursively? instructions: - text: List directory {path} on volume {vol}. slots: path: query.path vol: query.vol - text: Recursively list everything under {path} on volume {vol}. slots: path: query.path vol: query.vol method: generated generated: '2026-09-26' - target: $.paths['/fs/download-url'].get update: x-apievangelist-phrasing: intent: Get a download URL for a volume file effect: read questions: - How do I download a file from a volume? - Can I download an older version of a volume file? instructions: - text: Get a download URL for {path} on volume {vol}. slots: path: query.path vol: query.vol - text: Get a download link for version {version_id} of {path} on {vol}. slots: version_id: query.version_id path: query.path vol: query.vol method: generated generated: '2026-09-26' - target: $.paths['/fs/metadata'].get update: x-apievangelist-phrasing: intent: Get metadata for a file or folder effect: read questions: - What metadata is available for a file or folder on a volume? - Can I check a volume file's details without downloading it? instructions: - text: Get metadata for {path} on volume {vol}. slots: path: query.path vol: query.vol - text: Show details of {path} in volume {vol}. slots: path: query.path vol: query.vol method: generated generated: '2026-09-26' - target: $.paths['/fs/upload-url'].post update: x-apievangelist-phrasing: intent: Get an upload URL for a volume file effect: write questions: - How do I upload a file to a path on a volume? - Can I declare content type and size when getting a volume upload URL? instructions: - text: Get an upload URL for {path} on volume {vol}. slots: path: requestBody.path vol: requestBody.vol - text: Get an upload link for {path} on {vol} with content type {content_type}. slots: path: requestBody.path vol: requestBody.vol content_type: requestBody.content_type method: generated generated: '2026-09-26' - target: $.paths['/fs/mkdir'].post update: x-apievangelist-phrasing: intent: Create a directory in a volume effect: write questions: - How do I create a folder on a volume? - Can I make a new directory path on a volume? instructions: - text: Create directory {path} on volume {vol}. slots: path: requestBody.path vol: requestBody.vol - text: Make folder {path} in {vol}. slots: path: requestBody.path vol: requestBody.vol method: generated generated: '2026-09-26' - target: $.paths['/fs/move'].post update: x-apievangelist-phrasing: intent: Move or rename a file effect: write questions: - How do I rename a file on a volume? - Can I move a file from one volume to another? instructions: - text: Rename {source} to {destination} within volume {vol}. slots: source: requestBody.source destination: requestBody.destination vol: requestBody.vol - text: Transfer {source} from {vol} across to a different volume {destination_vol} at {destination}. slots: source: requestBody.source vol: requestBody.vol destination: requestBody.destination destination_vol: requestBody.destination_vol method: generated generated: '2026-09-26' - target: $.paths['/fs/versions'].get update: x-apievangelist-phrasing: intent: List a file's version history effect: read questions: - What earlier versions of a volume file exist? - Can I page through a file's version history? instructions: - text: List versions of {path} on volume {vol}. slots: path: query.path vol: query.vol - text: Show the last {limit} versions of {path} on {vol}. slots: limit: query.limit path: query.path vol: query.vol method: generated generated: '2026-09-26' - target: $.paths['/fs/restore-version'].post update: x-apievangelist-phrasing: intent: Restore a file to a previous version effect: write questions: - Can I restore a volume file to an earlier version? - How do I undo changes to a file on a volume? instructions: - text: Restore {path} on volume {vol} to version {version_id}. slots: path: requestBody.path vol: requestBody.vol version_id: requestBody.version_id - text: Roll file {path} in {vol} back to version {version_id}. slots: path: requestBody.path vol: requestBody.vol version_id: requestBody.version_id method: generated generated: '2026-09-26' - target: $.paths['/fs/delete'].post update: x-apievangelist-phrasing: intent: Delete a file or directory effect: destructive questions: - How do I delete a file from a volume? - Does deleting a folder on a volume remove everything inside it? instructions: - text: Delete {path} on volume {vol}. slots: path: requestBody.path vol: requestBody.vol - text: Recursively delete folder {path} from {vol}. slots: path: requestBody.path vol: requestBody.vol method: generated generated: '2026-09-26' - target: $.paths['/fs/streaming-token'].get update: x-apievangelist-phrasing: intent: Get a token for real-time volume change events effect: read questions: - Can I subscribe to real-time change events on a volume? - How do I get a streaming token scoped to a filesystem volume? instructions: - text: Get a streaming token for volume {vol}. slots: vol: query.vol - text: Watch volume {vol} for file changes. slots: vol: query.vol method: generated generated: '2026-09-26' - target: $.paths['/skills/create'].post update: x-apievangelist-phrasing: intent: Create a stored skill effect: write questions: - How do I create a reusable skill for my agents? - Can I describe when a skill should be used? instructions: - text: Create skill {skill_name} in scope {scope} described as {description} with content {content}. slots: skill_name: requestBody.skill_name scope: requestBody.scope description: requestBody.description content: requestBody.content - text: 'Add a new {scope} skill {skill_name}: {description}, used when {when_to_use}, content {content}.' slots: scope: requestBody.scope skill_name: requestBody.skill_name description: requestBody.description when_to_use: requestBody.when_to_use content: requestBody.content method: generated generated: '2026-09-26' - target: $.paths['/skills/update'].post update: x-apievangelist-phrasing: intent: Update an existing stored skill effect: write questions: - How do I edit a skill I already created? - Can I change an existing skill's content and description? instructions: - text: Update existing skill {skill_name} in scope {scope} with description {description} and content {content}. slots: skill_name: requestBody.skill_name scope: requestBody.scope description: requestBody.description content: requestBody.content - text: 'Revise the {scope} skill {skill_name}: new description {description}, new content {content}.' slots: scope: requestBody.scope skill_name: requestBody.skill_name description: requestBody.description content: requestBody.content method: generated generated: '2026-09-26' - target: $.paths['/skills/delete'].post update: x-apievangelist-phrasing: intent: Delete a stored skill effect: destructive questions: - How do I delete a stored skill? - Can I remove a skill from a scope? instructions: - text: Delete skill {skill_name} from scope {scope}. slots: skill_name: requestBody.skill_name scope: requestBody.scope - text: Remove the {scope} skill {skill_name}. slots: scope: requestBody.scope skill_name: requestBody.skill_name method: generated generated: '2026-09-26' - target: $.paths['/skills/read'].get update: x-apievangelist-phrasing: intent: Read a stored skill's content effect: read questions: - How do I read the content of one stored skill? - Can I read another user's skill in a scope? instructions: - text: Read skill {skill_name} in scope {scope}. slots: skill_name: query.skill_name scope: query.scope - text: Show the content of skill {skill_name} for user {user_id}. slots: skill_name: query.skill_name user_id: query.user_id method: generated generated: '2026-09-26' - target: $.paths['/skills/list'].get update: x-apievangelist-phrasing: intent: List stored skills in a scope effect: read questions: - Which skills are stored in a scope? - What skills have been saved for my agents? instructions: - text: List stored skills. - text: List the skills in scope {scope}. slots: scope: query.scope method: generated generated: '2026-09-26'