Relevance AI

Relevance AI Chat API

The chat API from Relevance AI — 161 operation(s) for chat.

GitHub OpenAPI

Operations 171

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /phone-numbers List phone numbers assigned to the project · ListProjectPhoneNumbers #
Ask an LLM
“Which phone numbers are assigned to my Relevance AI project?”
“Can I see only the project phone numbers from one telephony provider?”
Tell an agent
List every phone number assigned to this project.
Show the project phone numbers that come from provider {provider}.
POST /agents/clone Deep clone an agent with its tools and subagents · CloneAgent #
Ask an LLM
“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?”
Tell an agent
Deep clone agent template {template} with all its tools and subagents.
Clone agent {template} recursively and prefix the copied names with {prefix}.
POST /agents/clone_marketplace_template Clone a marketplace agent template · CloneAgentMarketplaceTemplate #
Ask an LLM
“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?”
Tell an agent
Clone marketplace template {template} into my project.
Install the marketplace agent template {template} as my own agent with its tools.
POST /agents/upsert Create or update an agent's configuration · UpsertAgent #
Ask an LLM
“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?”
Tell an agent
Create or update agent {agent_id} named {name}.
Set the system prompt of agent {agent_id} to {system_prompt} and use model {model}.
POST /agents/upsert_preset Set up a preset agent such as a meeting notetaker · UpsertPresetAgent #
Ask an LLM
“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?”
Tell an agent
Set up preset agent {preset_agent_id} in my project.
Install preset agent {preset_agent_id} as a new agent and sync its evals ({sync_evals}).
POST /agents/list Search and filter agents in the project · ListAgents #
Ask an LLM
“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?”
Tell an agent
Search the project's agents for {query}.
Find agents matching {query}, including public agents, page {page}.
POST /agents/list-my-agents List agents I created · ListMyAgents #
Ask an LLM
“Which agents have I personally created?”
“Can I page through only my own agents, sorted my way?”
Tell an agent
List the agents I created.
Show my own agents, {page_size} per page, sorted by {sort}.
GET /agents/{agent_id}/get Get an agent's details · GetAgent #
Ask an LLM
“How do I fetch the full configuration of one agent?”
“Can I retrieve a specific version of an agent rather than the current one?”
Tell an agent
Get agent {agent_id}.
Retrieve agent {agent_id} at version {version}.
POST /agents/tools/list List tools across several agents · ListAgentsToolsView #
Ask an LLM
“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?”
Tell an agent
Show the tools used by agents {agent_ids}.
List tools for this batch of agents: {agent_ids}.
POST /agents/{agent_id}/tools/list Get the tools attached to one agent · GetAgentsTools #
Ask an LLM
“Which tools is a single agent allowed to use?”
“Can I include phantom tools when listing one agent's tools?”
Tell an agent
List the tools attached to agent {agent_id}.
Show tools for agent {agent_id} at version {agent_version}, including phantom tools.
POST /agents/{agent_id}/dependency-versions/metadata/list List metadata for an agent's pinned dependencies · ListAgentDependencyVersionMetadata #
Ask an LLM
“What versions are my agent's pinned subagent dependencies on?”
“Can I get display details for the agents that another agent depends on?”
Tell an agent
Show pinned dependency metadata for agent {agent_id} covering {dependencies}.
List the pinned direct agent dependencies {dependencies} of agent {agent_id}.
POST /agents/trigger Send a message to an agent to run it · TriggerAgent #
Ask an LLM
“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?”
Tell an agent
Trigger agent {agent_id}.
Send agent {agent_id} a new run in conversation {conversation_id}.
POST /agents/bulk_trigger Trigger an agent in bulk across rows · BulkTriggerAgents #
Ask an LLM
“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?”
Tell an agent
Bulk trigger agent {agent_id} across the matching rows.
Bulk run agent {agent_id} with at most {max_rows_at_once} rows at once.
POST /agents/get_embed_key Get an embed key for an agent · GetEmbedKeyForAgent #
Ask an LLM
“How do I get a key to embed an agent on my website?”
“Where does the embed key for a single agent come from?”
Tell an agent
Generate an embed key for agent {agent_id} in project {project}.
Give me the embed key for agent {agent_id}, project {project}.
POST /agents/{agent_id}/delete Delete an agent · DeleteAgent #
Ask an LLM
“How do I permanently remove an agent from my project?”
“What happens when I delete an agent I no longer use?”
Tell an agent destructive · confirm first
Delete agent {agent_id}.
Remove the agent {agent_id} from the project.
POST /agents/{agent_id}/suggest_replies Suggest replies to an agent's latest message · SuggestReplies #
Ask an LLM
“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?”
Tell an agent
Suggest replies for conversation {conversation_id} with agent {agent_id}.
Draft reply suggestions in conversation {conversation_id} of agent {agent_id} following {instructions}.
GET /agents/prompt_models/list List LLMs supported for agent prompts · ListAgentPromptModels #
Ask an LLM
“Which LLMs are supported for agent prompts?”
“What prompt models can I pick when configuring an agent?”
Tell an agent
List the supported prompt LLMs for agents.
Show me the agent prompt model options.
GET /agents/models/list List available LLMs · ListModels #
Ask an LLM
“What large language models are available on the platform?”
“Can I narrow the LLM catalog to a particular model subset?”
Tell an agent
List all available LLMs.
List LLMs in model subset {model_subset}.
GET /agents/models/stt/list List speech-to-text models · ListSTTModels #
Ask an LLM
“Which speech-to-text models can a voice agent use?”
“What transcription models are available?”
Tell an agent
List the speech-to-text models.
Show available STT models for voice agents.
GET /agents/models/tts/list List text-to-speech models · ListTTSModels #
Ask an LLM
“Which text-to-speech voices or models can my agent speak with?”
“What TTS models are offered?”
Tell an agent
Show the voice models agents can speak with.
Show available TTS models for voice output.
POST /agents/{agent_id}/scheduled_triggers_group/upsert Configure an agent's scheduled message group · UpsertAgentScheduledTriggersGroup #
Ask an LLM
“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?”
Tell an agent
Set up the scheduled trigger group for agent {agent_id} with a max of {max_count}.
For agent {agent_id}, skip scheduled triggers while a conversation is active: {prevent_triggering_if_conversation_active}.
POST /agents/{agent_id}/scheduled_triggers_item/create Schedule a future message for an agent · CreateAgentScheduledTriggersItem #
Ask an LLM
“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?”
Tell an agent
Schedule message {message} to agent {agent_id} in conversation {conversation_id} in {minutes_until_schedule} minutes.
Queue a follow-up {message} for agent {agent_id}, conversation {conversation_id}, after {minutes_until_schedule} minutes.
POST /trigger/recurring/callback Fire a recurring trigger · TriggerRecurring #
Ask an LLM
“How is a recurring sync trigger fired through its callback?”
“Can a recurring trigger be fired as a one-off with a custom message?”
Tell an agent
Fire recurring trigger {sync_id} for user {key_user_id} in project {project}.
Run recurring trigger {sync_id} once with message {message} for user {key_user_id} in project {project}.
POST /agents/{agent_id}/scheduled_triggers_item/cancel Cancel a scheduled agent message · CancelAgentScheduledTriggerItem #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Cancel scheduled message {trigger_id} for agent {agent_id}.
Stop the pending scheduled trigger {trigger_id} on agent {agent_id}.
POST /agents/{agent_id}/generate_requirements Get auth account requirements for an agent's tools · GenerateAgentRequirements #
Ask an LLM
“Which connected accounts does an agent's tools need before it can run?”
“What auth credentials are my agent's tools missing?”
Tell an agent
Show the auth account requirements for agent {agent_id}.
Check which tool accounts agent {agent_id} needs connected.
POST /agents/aggregate_tagged_conversations Aggregate tagged agent conversations · AggregateTaggedAgentConversations #
Ask an LLM
“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?”
Tell an agent
Aggregate tagged agent conversations using {aggregation_query}.
Summarize tagged conversations in dataset {dataset_id}.
POST /agents/list_custom_metadata List custom metadata fields used by agents · ListAgentsCustomMetadata #
Ask an LLM
“What custom metadata fields are defined across my agents?”
“Can I see the custom metadata keys on one particular agent?”
Tell an agent
List all custom metadata fields across agents.
Show custom metadata fields for agent {agent_id}.
POST /agents/generate_params_schema Generate a params schema from an agent's variables · GenerateAgentParamsSchema #
Ask an LLM
“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?”
Tell an agent
Generate a params schema for agent definition {agent}.
Detect variables in {agent} and output the full params schema.
GET /agents/conversations/list List agent conversations · ListConversations #
Ask an LLM
“How do I list all conversations my agents have had?”
“Can I mask PII when pulling back agent conversations?”
Tell an agent
List agent conversations, page {page}.
Search agent conversations for {query} with PII masked.
GET /agents/tasks/match-groups/{hash}/conversations List conversations in a match group by hash (deprecated) · ListMatchGroupConversations #
Ask an LLM
“Which conversations belong to a task match group hash on the older deprecated endpoint?”
“Can I still page through match group conversations by hash?”
Tell an agent
List conversations for match group hash {hash} using the deprecated endpoint.
Show page {page} of conversations in match group {hash}.
GET /agents/tasks/match-group-conversations List conversations matching a task group selector · ListConversationsForMatchGroup #
Ask an LLM
“What conversations match a task ops group selector?”
“Can I page through the conversations behind one grouped task view?”
Tell an agent
List conversations matching task group selector {selector}.
Show {page_size} conversations for group selector {selector}.
GET /agents/tasks/groups List grouped task views with counts · ListTaskGroups #
Ask an LLM
“How are my agent tasks grouped, and how many are in each group?”
“Can I group task ops by a field other than agent?”
Tell an agent
Show grouped task counts by agent.
Group agent tasks by {group_by} and show counts.
GET /agents/tasks/groups/tasks List tasks inside one task group · ListTasksForGroup #
Ask an LLM
“Which tasks sit inside a particular grouped task ops group?”
“Can I include eval details for the tasks in one group?”
Tell an agent
List the tasks in task group {group}.
Search tasks in group {group} for {query}.
GET /agents/conversations/export Export agent conversations to CSV · ExportConversations #
Ask an LLM
“Can I download my agent conversations as a CSV file?”
“Is PII masking available when exporting conversations to a spreadsheet?”
Tell an agent
Export agent conversations to CSV.
Export conversations matching {query} to CSV with PII masked.
GET /agents/conversations/latest_update_datetime Get when an agent's conversations last changed · LatestConversationUpdateDatetime #
Ask an LLM
“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?”
Tell an agent
Get the latest conversation update time for agent {agent_id}.
Check when agent {agent_id} last had a conversation update.
GET /agents/conversations/studios/list List tool runs within an agent conversation · ListConversationStudiosHistory #
Ask an LLM
“Which tools (studios) ran during a given agent conversation?”
“Can I page through the studio run history of one conversation?”
Tell an agent
List studio runs in conversation {conversation_id} of agent {agent_id}.
Show the tool history for conversation {conversation_id}.
POST /agents/{agent_id}/cancel Stop a running agent · CancelAgent #
Ask an LLM
“How do I stop an agent that is currently running?”
“Can I cancel an in-progress agent job?”
Tell an agent destructive · confirm first
Cancel the running agent {agent_id}.
Stop agent {agent_id} now.
POST /agents/{agent_id}/submit-message-feedback Submit feedback on an agent message · SubmitMessageFeedback #
Ask an LLM
“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?”
Tell an agent
Mark message {message_id} in conversation {conversation_id} of agent {agent_id} as positive: {is_feedback_positive}, tags {task_tags}, details {task_details}.
Add note {notes} as feedback on message {message_id} from agent {agent_id}.
POST /agents/analytics Get time-series analytics for agents · GetAgentAnalytics #
Ask an LLM
“What does agent usage look like over time?”
“Can I filter agent time-series analytics?”
Tell an agent
Show time-series analytics for my agents.
Get agent analytics filtered by {filters}.
POST /agents/{agent_id}/batch-schedule-agent-tasks Page through an agent's batch-scheduled tasks · BatchScheduleAgentTasks #
Ask an LLM
“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?”
Tell an agent
Show batch-scheduled tasks for agent {agent_id} in knowledge set {knowledge_set}, document {sync_document_id}.
Page through agent {agent_id}'s batch schedule {sync_document_id} in set {knowledge_set}.
POST /agents/{agent_id}/batch-schedule-agent-tasks/create Batch-schedule tasks for an agent · CreateBatchScheduleAgentTasks #
Ask an LLM
“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?”
Tell an agent
Batch-schedule tasks for agent {agent_id} named {display_name} with template {message_template} and pacing {contract}.
Schedule agent {agent_id} tasks from CSV {csv} using template {message_template}, name {display_name}, pacing {contract}.
POST /agents/{agent_id}/batch-schedule-agent-tasks/cancel Cancel an agent's batch-scheduled tasks · CancelBatchScheduleAgentTasksGroup #
Ask an LLM
“How do I cancel a batch of scheduled tasks for an agent?”
“Does cancelling a batch schedule also cancel its individual items?”
Tell an agent destructive · confirm first
Cancel batch schedules {sync_document_ids} for agent {agent_id}.
Cancel all items in agent {agent_id}'s batch group {sync_document_ids}.
POST /agents/{agent_id}/batch-schedule-agent-tasks/pause Pause an agent's batch-scheduled tasks · PauseBatchScheduleAgentTasksGroup #
Ask an LLM
“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?”
Tell an agent
Pause batch schedules {sync_document_ids} for agent {agent_id}.
Hold agent {agent_id}'s batch task group {sync_document_ids}.
POST /agents/{agent_id}/batch-schedule-agent-tasks/resume Resume an agent's paused batch-scheduled tasks · ResumeBatchScheduleAgentTasksGroup #
Ask an LLM
“How do I restart a paused batch of scheduled agent tasks?”
“Can a paused agent batch schedule pick up where it left off?”
Tell an agent
Resume batch schedules {sync_document_ids} for agent {agent_id}.
Unpause agent {agent_id}'s batch task group {sync_document_ids}.
POST /agents/{agent_id}/tasks/{knowledge_set}/view View messages in an agent task · ListAgentTaskView #
Ask an LLM
“How do I read the messages of one agent task conversation?”
“Can I include debug details and metadata when viewing an agent task?”
Tell an agent
Show the task view for agent {agent_id}, task {knowledge_set}.
View agent {agent_id} task {knowledge_set} with debug info, {page_size} messages per page.
GET /agents/{agent_id}/tasks/{knowledge_set}/trigger_message Get the message that triggered an agent task · GetAgentTaskViewTriggerMessage #
Ask an LLM
“What message kicked off a particular agent task?”
“Can I see the original trigger message for an agent conversation?”
Tell an agent
Get the trigger message for agent {agent_id}, task {knowledge_set}.
Show what started task {knowledge_set} on agent {agent_id}.
POST /agents/recallai/desktop-sdk-upload Create a Recall.ai desktop recording upload · CreateRecallAiDesktopSdkUpload #
Ask an LLM
“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?”
Tell an agent
Create a Recall.ai desktop SDK upload.
Create a Recall.ai desktop upload with recording config {recording_config}.
POST /agents/view/list List agents in display view · ListAgentsView #
Ask an LLM
“Can I get the lightweight display list of agents for a table view?”
“What sort orders does the agents display view accept?”
Tell an agent
Show the agents display view.
List agents for display sorted by {sort}.
GET /agents/count Count agents in the project · CountAgents #
Ask an LLM
“How many agents are in my project?”
“Is there a quick total of agents without listing them?”
Tell an agent
Count the agents in this project.
Tell me the total number of agents.
POST /agents/conversations/bulk/approve Bulk approve agent conversations · BulkApproveConversations #
Ask an LLM
“Can I approve many pending agent conversations at once?”
“What do I need to bulk approve conversations waiting on human review?”
Tell an agent
Approve conversations {conversation_ids} for agent {agent_id}.
Bulk approve agent {agent_id}'s pending conversations {conversation_ids}.
POST /agents/conversations/bulk/reject Bulk reject agent conversations · BulkRejectConversations #
Ask an LLM
“Can I reject a batch of agent conversations awaiting approval?”
“Is there a bulk way to decline an agent's pending actions?”
Tell an agent
Reject conversations {conversation_ids} for agent {agent_id}.
Bulk decline agent {agent_id}'s pending conversations {conversation_ids}.
POST /agents/conversations/bulk/respond Bulk respond to agent escalations · BulkRespondConversations #
Ask an LLM
“How do I answer many agent escalations with the same reply?”
“Can I respond to several escalated conversations in one go?”
Tell an agent
Reply {response_text} to escalations {escalations} for agent {agent_id}.
Bulk respond to agent {agent_id}'s escalations {escalations} with {response_text}.
POST /agents/conversations/bulk/rerun Bulk rerun agent conversations · BulkRerunConversations #
Ask an LLM
“Can I rerun a set of agent conversations after changing the agent?”
“Is it possible to replay many conversations at once?”
Tell an agent
Rerun conversations {conversation_ids} for agent {agent_id}.
Bulk rerun agent {agent_id}'s conversations.
GET /agents/versions/{version_id}/get Get one saved version of an agent · GetAgentVersion #
Ask an LLM
“How do I look at a specific saved version of an agent?”
“Can I fetch an agent version by its version ID?”
Tell an agent
Get agent version {version_id}.
Show the config stored in agent version {version_id}.
POST /agents/versions/list List an agent's version history · ListAgentVersions #
Ask an LLM
“What versions exist for an agent?”
“Can I page through an agent's version history?”
Tell an agent
List versions of agent {agent_id}.
Show {page_size} versions per page for agent {agent_id}.
POST /agents/versions/upsert Create or update an agent version record · UpsertAgentVersion #
Ask an LLM
“How do I create or edit a named version record for an agent?”
“Can I partially update an agent version's config?”
Tell an agent
Create or update a version of agent {agent_id} named {name}.
Update agent version {version_id} of agent {agent_id} with description {description}.
POST /agents/versions/restore Restore an old agent version as the draft · RestoreAgentVersion #
Ask an LLM
“How do I roll an agent back to an earlier version?”
“What happens to the current draft when I restore an old agent version?”
Tell an agent
Restore agent version {version_id} as the current draft.
Roll back to agent version {version_id}.
POST /agents/versions/draft Save agent changes as a draft version · SaveAgentAsDraft #
Ask an LLM
“Can I save changes to an agent as a draft without making them live?”
“Does saving an agent draft overwrite an existing draft?”
Tell an agent
Save agent {agent_id} as a draft.
Save a draft of agent {agent_id} with system prompt {system_prompt}.
POST /agents/versions/publish Publish an agent's draft as the active version · PublishAgent #
Ask an LLM
“How do I make my agent's draft version live?”
“Can I publish the current draft of an agent through the API?”
Tell an agent
Publish the draft of agent {agent_id}.
Make agent {agent_id}'s draft the active version.
POST /agents/{agent_id}/generate-card-artwork Generate pixel art card artwork for an agent · GenerateAgentCardArtwork #
Ask an LLM
“Can AI generate pixel art card artwork for my agent?”
“Which Gemini models can I choose for generating agent card art?”
Tell an agent
Generate card artwork for agent {agent_id}.
Create pixel art for agent {agent_id} using image model {img_gen_gemini_model}.
GET /agents/{agent_id}/pre-publish-checks List an agent's pre-publish checks · ListPrePublishChecks #
Ask an LLM
“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?”
Tell an agent
List pre-publish checks for agent {agent_id}.
Show pre-publish check results for agent {agent_id}, version {version_id}.
POST /folders/upsert Create or update a folder · UpsertFolder #
Ask an LLM
“How do I organize my agents into folders?”
“Can I nest a folder under a parent folder?”
Tell an agent
Create a folder named {name} of type {folder_type}.
Rename folder {folder_id} to {name} under parent {parent_folder_id}, type {folder_type}.
DELETE /folders/{folder_id}/delete Delete a folder · DeleteFolder #
Ask an LLM
“How do I delete a folder I used for organizing agents?”
“Can I remove an empty agent folder?”
Tell an agent destructive · confirm first
Delete folder {folder_id}.
Remove the folder {folder_id}.
POST /agents/meeting/connection-details Get LiveKit connection details for a meeting agent · GetMeetingAgentConnectionDetails #
Ask an LLM
“How do I connect to the LiveKit room for a meeting agent?”
“What connection details does a meeting agent conversation expose?”
Tell an agent
Get meeting connection details for agent {agent_id}, conversation {conversation_id}, project {project_id}.
Fetch the LiveKit room details for meeting conversation {conversation_id} with agent {agent_id} in project {project_id}.
POST /mcp/list List tools on a remote MCP server · ListRemoteMcpServerTools #
Ask an LLM
“What tools does a remote MCP server expose?”
“Can I preview an MCP server's tools by URL before connecting it?”
Tell an agent
List tools from the MCP server at {url}.
Show tools for saved MCP server config {mcp_server_config_id}.
POST /agents/tasks/{knowledge_set}/messages/{document_id}/generate Generate markup for an agent task message · GenerateAgentMessage #
Ask an LLM
“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?”
Tell an agent
Generate markup for message {document_id} in task {knowledge_set}.
Generate markup for message {document_id} in task {knowledge_set} using prompts {prompts}.
PATCH /agents/tasks/{knowledge_set}/messages/{document_id}/generate Apply generated markup to an agent message · ApplyGeneratedAgentMessage #
Ask an LLM
“How do I save generated markup back onto an agent task message?”
“What signature is needed to apply a generated agent message?”
Tell an agent
Apply generated content {content} of type {type} to message {document_id} in task {knowledge_set}, safe {is_safe}, signature {signature}.
Apply the signed ({signature}) generated {type} markup {content} to message {document_id} of task {knowledge_set}, is_safe {is_safe}.
GET /agents/{agent_id}/tasks/{knowledge_set}/metadata Get metadata for an agent conversation · GetAgentConversationMetadata #
Ask an LLM
“What metadata is stored on one agent conversation?”
“Can I get a streaming token along with an agent conversation's metadata?”
Tell an agent
Get metadata for agent {agent_id} conversation {knowledge_set}.
Show agent {agent_id} conversation {knowledge_set} metadata with a streaming token.
POST /mas/{mas_id}/scratchpad/options List tools and scratchpad values for a multi-agent system · ListMasScratchpadOptions #
Ask an LLM
“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?”
Tell an agent
List scratchpad options for multi-agent system {mas_id}.
Show missing scratchpad values for multi-agent system {mas_id} and agent {agent_id}.
GET /workforce/items/{document_id} Get a workforce's configuration · GetWorkforce #
Ask an LLM
“How do I fetch a workforce's graph and settings?”
“Can I retrieve a specific version of a workforce instead of the active one?”
Tell an agent
Get workforce {document_id}.
Retrieve workforce {document_id} at version {version}.
POST /workforce/items/{document_id} Save a workforce configuration · SaveWorkforce #
Ask an LLM
“How do I save changes to a workforce's graph of agents?”
“Can I save and publish a workforce in the same call?”
Tell an agent
Save workforce {document_id} with graph {workforce_graph}, metadata {workforce_metadata}, publish {should_publish}.
Update the workforce {document_id} graph to {workforce_graph} and metadata {workforce_metadata} without publishing ({should_publish}).
DELETE /workforce/items/{document_id} Delete a workforce and its versions · DeleteWorkforce #
Ask an LLM
“How do I permanently delete a workforce?”
“Are a workforce's saved versions removed when I delete it?”
Tell an agent destructive · confirm first
Delete workforce {document_id}.
Remove workforce {document_id} and all its versions.
GET /workforce/items/public/{document_id} Get a public workforce's active version · GetPublicWorkforce #
Ask an LLM
“Can I view a workforce that has been shared publicly?”
“What does the public view of a workforce return?”
Tell an agent
Get public workforce {document_id}.
Show public workforce {document_id} from project {project}.
POST /workforce/duplicate Duplicate a workforce from its published version · DuplicateWorkforce #
Ask an LLM
“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?”
Tell an agent
Duplicate the published version of workforce {workforce_id}.
Make a copy of workforce {workforce_id} from what is published.
POST /workforce/list List workforces in the project · ListWorkforces #
Ask an LLM
“Which workforces exist in my project?”
“Can I search workforces by name and include their nodes?”
Tell an agent
List the workforces in this project.
Search workforces for {searchQuery}.
POST /workforce/trigger Run a workforce · TriggerWorkforce #
Ask an LLM
“How do I kick off a workforce run through the API?”
“Can I continue an existing workforce task when triggering it?”
Tell an agent
Trigger workforce {workforce_id} with {trigger}.
Run workforce {workforce_id} on task {workforce_task_id} with trigger {trigger}.
POST /workforce/rerun Rerun a workforce from a specific event · RerunWorkforceFromEvent #
Ask an LLM
“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?”
Tell an agent
Rerun workforce {workforce_id} task {workforce_task_id} from event {node_started_event_id}.
Replay task {workforce_task_id} of workforce {workforce_id} starting at node event {node_started_event_id}.
POST /workforce/tasks/list List a workforce's tasks · ListWorkforceTasks #
Ask an LLM
“What tasks has a workforce run?”
“Can I search a workforce's tasks by text?”
Tell an agent
List tasks for workforce {workforce_id}.
Search workforce {workforce_id} tasks for {query}.
POST /workforce/items/{workforce_id}/tasks/{task_id}/messages List messages in a workforce task · ListWorkforceTaskMessages #
Ask an LLM
“How do I read the message thread of a workforce task?”
“Can I include debug metadata when listing workforce task messages?”
Tell an agent
List messages in task {task_id} of workforce {workforce_id}.
Show {page_size} messages from workforce {workforce_id} task {task_id}.
PATCH /workforce/items/{workforce_id}/tasks/{task_id}/state Change the state of a workforce task · UpdateWorkforceTaskState #
Ask an LLM
“Can I change the state of a workforce task, for example to stop it?”
“What task states can I request for a workforce task?”
Tell an agent
Set workforce {workforce_id} task {task_id} to state {requested_state}.
Move task {task_id} in workforce {workforce_id} to {requested_state}.
PATCH /workforce/items/{workforce_id}/tasks/{task_id}/title Rename a workforce task · UpdateWorkforceTaskTitle #
Ask an LLM
“How do I rename a workforce task?”
“Can I change the title shown for a workforce task?”
Tell an agent
Rename workforce {workforce_id} task {task_id} to {title}.
Set the title of task {task_id} in workforce {workforce_id} to {title}.
POST /workforce/tasks/delete Delete workforce tasks · DeleteWorkforceTasks #
Ask an LLM
“Can I delete several workforce tasks at once?”
“How do I clear out old workforce tasks?”
Tell an agent destructive · confirm first
Delete workforce tasks {workforce_task_ids}.
Remove these workforce tasks: {workforce_task_ids}.
POST /workforce/versions/list List a workforce's version history · ListWorkforceVersions #
Ask an LLM
“What versions exist for a workforce?”
“Can I page through a workforce's version history?”
Tell an agent
List versions of workforce {workforce_id}.
Show {page_size} versions per page for workforce {workforce_id}.
POST /workforce/versions/upsert Create or update a workforce version record · UpsertWorkforceVersion #
Ask an LLM
“How do I create or edit a named version of a workforce?”
“Can I partially update a workforce version's config?”
Tell an agent
Create or update a version of workforce {workforce_id} named {name}.
Update workforce version {version_id} of workforce {workforce_id} with description {description}.
POST /workforce/versions/restore Restore an old workforce version as the draft · RestoreWorkforceVersion #
Ask an LLM
“How do I roll a workforce back to an earlier version?”
“What happens to the draft when I restore an old workforce version?”
Tell an agent
Restore workforce version {version_id} as the current draft.
Roll the workforce back to version {version_id}.
POST /workforce/clone Clone a workforce from a source · CloneWorkforce #
Ask an LLM
“Can I clone a workforce from a source such as a template?”
“How do I create a new workforce by cloning another one?”
Tell an agent
Clone workforce from source {source}.
Create a new workforce cloned from {source}.
POST /workforce/set_entities_public Make all agents and tools in a workforce public · SetEntitiesInWorkforcePublic #
Ask an LLM
“How do I make every agent and tool inside a workforce public?”
“Does making a workforce's entities public also cover subagents?”
Tell an agent
Set all agents and tools in workforce {workforce_id} to public.
Publish every entity used by workforce {workforce_id} publicly.
POST /workforce/{workforce_id}/scratchpad/options List tool outputs available in a workforce · ListWorkforceScratchpadOptions #
Ask an LLM
“What tool outputs can nodes in a workforce reference?”
“Can I list all outputs of all tools across a workforce's agents?”
Tell an agent
List scratchpad options for workforce {workforce_id}.
Show every tool output available in workforce {workforce_id}.
GET /workforce/tasks/{task_id}/metadata Get metadata for a workforce conversation · GetWorkforceConversationMetadata #
Ask an LLM
“What metadata is stored on a workforce task conversation?”
“Can I get a streaming token with a workforce conversation's metadata?”
Tell an agent
Get metadata for workforce task {task_id}.
Show workforce conversation {task_id} metadata including a streaming token.
GET /workforce/{workforce_id}/streaming-token/{workforce_task_id} Get a streaming token for a workforce task · GetWorkforceStreamingToken #
Ask an LLM
“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?”
Tell an agent
Get a streaming token for workforce {workforce_id}, task {workforce_task_id}.
Fetch the stream token for task {workforce_task_id} on workforce {workforce_id}.
POST /workforce/node/test Test a single node in a workforce · TestWorkforceNode #
Ask an LLM
“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?”
Tell an agent
Test node {node_id} in workforce {workforce_id}.
Run node {node_id} of workforce {workforce_id} with message {message}.
POST /workforce/get_embed_key Get an embed key for a workforce · GetEmbedKeyForWorkforce #
Ask an LLM
“How do I get a key to embed a workforce publicly?”
“Where does a workforce's embed key come from?”
Tell an agent
Generate an embed key for workforce {workforce_id} in project {project}.
Give me the public embed key for workforce {workforce_id}, project {project}.
GET /workforce/count Count workforces in the project · CountWorkforces #
Ask an LLM
“How many workforces does my project have?”
“Is there a quick total of workforces?”
Tell an agent
Count the workforces in this project.
Tell me the total number of workforces.
POST /sync/template Create or update a sync template · UpsertSyncTemplate #
Ask an LLM
“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?”
Tell an agent
Create a sync template of type {type} with config {config}.
Update sync template {sync_template_id} of type {type} to config {config}.
GET /triggers/{trigger_group_id}/summary Get a trigger group's progress summary · GetTriggerGroupSummary #
Ask an LLM
“How far along is a trigger group and how is it configured?”
“Can I check progress on one specific trigger group?”
Tell an agent
Summarize trigger group {trigger_group_id}.
Show progress for trigger group {trigger_group_id}.
POST /agents/{agent_id}/triggers/summaries List trigger group summaries for an agent · ListAgentTriggerGroupsSummaries #
Ask an LLM
“What trigger groups does a given agent have?”
“Can I filter an agent's trigger groups by type or status?”
Tell an agent
List trigger group summaries for agent {agent_id} from cursor {cursor}.
Show agent {agent_id} trigger groups with status {statuses}, cursor {cursor}.
POST /triggers/summaries List trigger group summaries for a destination · ListTriggerGroupsSummaries #
Ask an LLM
“Which trigger groups point at a given destination?”
“Can I filter trigger group summaries by destination and status?”
Tell an agent
List trigger group summaries for destination {destination} from cursor {cursor}.
Show trigger groups of type {trigger_types} targeting destination {destination}, cursor {cursor}.
POST /agents/{agent_id}/active_triggers/overview Overview of an agent's active trigger groups · ListAgentActiveTriggerGroupsOverview #
Ask an LLM
“Which trigger groups are currently active for an agent?”
“Is there an overview of live triggers on one agent?”
Tell an agent
Show the active trigger overview for agent {agent_id}.
List the triggers currently live on agent {agent_id}.
POST /triggers/active/overview Overview of active trigger groups for a destination · GetActiveTriggerGroupsOverview #
Ask an LLM
“Which trigger groups are active for a particular destination?”
“Can I see live triggers by destination rather than by agent?”
Tell an agent
Show the active trigger overview for destination {destination}.
Get active trigger groups targeting destination {destination}.
POST /trigger/items/view List items in a trigger group · ListTriggerItemsView #
Ask an LLM
“What individual items are inside a trigger group?”
“Can I filter a trigger group's items by simplified status?”
Tell an agent
List items in trigger group {trigger_group_id} with status {simplified_status} from cursor {cursor}.
Show {page_size} {simplified_status} items for trigger group {trigger_group_id}, cursor {cursor}.
POST /triggers/update_status Change a trigger group's status · UpdateTriggerGroupStatus #
Ask an LLM
“How do I change the status of a trigger group?”
“Can I switch a trigger group on or off by status?”
Tell an agent
Set trigger group {trigger_group_id} status to {status}.
Update the status of trigger group {trigger_group_id} to {status}.
POST /triggers/bulk_cancel Cancel all upcoming items in a trigger group · BulkCancelUpcomingSyncItems #
Ask an LLM
“Can I cancel every upcoming item in a trigger group at once?”
“How do I stop all pending scheduled items for a trigger group?”
Tell an agent destructive · confirm first
Cancel all upcoming items in trigger group {trigger_group_id}.
Bulk cancel pending sync items for trigger group {trigger_group_id}.
POST /sync-items/collections/{collection_id}/bulk/update_status Bulk update sync item statuses in a collection · BulkUpdateSyncItemsStatus #
Ask an LLM
“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?”
Tell an agent
Update sync items in collection {collection_id} matching {filters} with {update}.
Apply status change {update} to items in collection {collection_id} filtered by {filters}.
POST /batch-schedule-tasks/create Batch-schedule tasks for a destination · CreateBatchScheduleTasks #
Ask an LLM
“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?”
Tell an agent
Batch-schedule tasks named {display_name} to destination {destination} with template {message_template} and pacing {contract}.
Schedule tasks from CSV {csv} to destination {destination} using {message_template}, name {display_name}, pacing {contract}.
POST /trigger/pull/test Fetch sample data to test a trigger · PullTestTriggerData #
Ask an LLM
“Can I pull the latest data a trigger would receive to test it?”
“How do I preview trigger data before turning a trigger on?”
Tell an agent
Pull test data for trigger config {sync_config}.
Fetch the latest trigger data for {sync_config}.
GET /chats/agents List agents visible in the chat app · ListAgentsForChat #
Ask an LLM
“Which agents show up in the chat app?”
“Can I search the agents available to chat with?”
Tell an agent
List agents available in chat.
Search chat agents for {query}.
GET /chats/settings Get my chat settings · GetUsersChatSettings #
Ask an LLM
“What are my personal chat settings?”
“Where can I see my own chat preferences?”
Tell an agent
Get my chat settings.
Show my personal chat preferences.
POST /chats/settings Update my chat settings · UpdateUsersChatSettings #
Ask an LLM
“How do I change my personal chat settings?”
“Can I update my own chat preferences without affecting the project?”
Tell an agent
Update my chat settings to {settings}.
Change my personal chat preferences to {settings}.
GET /chats/project-settings Get project-level chat settings · GetProjectChatSettings #
Ask an LLM
“What chat settings apply to the whole project?”
“Can I view the project-wide chat configuration?”
Tell an agent
Get the project chat settings.
Show project-wide chat configuration.
POST /chats/project-settings Update project-level chat settings · UpdateProjectChatSettings #
Ask an LLM
“How does an admin change chat settings for the whole project?”
“Can I hide agents from chat for everyone in the project?”
Tell an agent
Update the project chat settings to {settings}.
Set project-wide chat configuration to {settings}.
GET /chats/settings/configurable-tool-permissions List tool actions with configurable permissions · ListConfigurableToolPermissions #
Ask an LLM
“Which tool actions can I set permission rules for in chat?”
“What tool permissions are configurable?”
Tell an agent
List configurable tool permissions.
Show tool actions I can set permission rules on.
GET /chats/settings/available-options List mounts and skills available in chat · GetChatSettingsAvailableOptions #
Ask an LLM
“What mounts and skills can I toggle on or off in chat?”
“Can I search the skills available for chat?”
Tell an agent
List the mounts and skills I can toggle in chat.
Search chat skills for {skills_query}.
POST /chats/missing-inputs Check missing inputs before a workforce chat · GetWorkforceChatMissingInputs #
Ask an LLM
“Which manual inputs does a workforce chat need before I trigger it?”
“Can I check whether a chat message is missing required tool inputs?”
Tell an agent
Check missing inputs for chat message {message}.
List required inputs missing for message {message} in chat {workforce_task_id}.
POST /chats/prerequisites Check inputs and MCP auth before a workforce chat · GetWorkforceChatPrerequisites #
Ask an LLM
“Can I check both missing inputs and MCP authentication before starting a chat?”
“What prerequisites must be satisfied before a workforce chat runs?”
Tell an agent
Check chat prerequisites, including MCP auth, before triggering.
Check prerequisites and MCP auth for message {message} in chat {workforce_task_id}.
POST /chats/trigger Send a message in a chat · TriggerWorkforceChat #
Ask an LLM
“How do I start or continue a chat through the API?”
“Can I apply a branding kit when triggering a chat?”
Tell an agent
Start a chat with {trigger}.
Send {trigger} in chat {workforce_task_id}.
GET /chats/{workforce_task_id}/get Get a single chat · GetWorkforceChat #
Ask an LLM
“How do I fetch one chat by its ID?”
“Can I get a streaming token together with a chat?”
Tell an agent
Get chat {workforce_task_id}.
Open chat {workforce_task_id} with a streaming token.
GET /chats List chats · ListWorkforceChats #
Ask an LLM
“Which chats have I had?”
“Can I search or filter my chats by tag?”
Tell an agent
List my chats.
Search my chats for {query}.
POST /chats/update Update a chat's model or agents · UpdateWorkforceChat #
Ask an LLM
“Can I switch the model used in an existing chat?”
“How do I remove agents from a chat?”
Tell an agent
Switch chat {workforce_task_id} to model {chat_model}.
Remove agents {remove_agent_ids} from chat {workforce_task_id}.
POST /chats/delete Delete a chat · DeleteWorkforceChat #
Ask an LLM
“How do I delete a chat?”
“Can I permanently remove a chat from my history?”
Tell an agent destructive · confirm first
Delete chat {workforce_task_id}.
Remove chat {workforce_task_id} from my history.
GET /chats/{task_id}/credit-usage Get credits used by a chat · GetWorkforceChatCredits #
Ask an LLM
“How many credits has a chat used?”
“Can I see the total credit cost of one chat task?”
Tell an agent
Get credit usage for chat {task_id}.
Show how many credits chat {task_id} consumed.
GET /preset_agents List preset agent templates · ListPresetAgents #
Ask an LLM
“What preset agents are available to set up?”
“Can I search the preset agent catalog?”
Tell an agent
List preset agents.
Search preset agents for {query}.
GET /beta/chat/super-agent/tasks Get super agent chat tasks in a time range · BetaGetSuperAgentChatTasks #
Ask an LLM
“Can I pull super agent chat tasks between two dates?”
“Which super agent chat tasks ran in a given period?”
Tell an agent
Get super agent chat tasks from {start_datetime} to {end_datetime}.
List super agent chat tasks since {start_datetime}.
GET /beta/chat/super-agent/files Get super agent chat files in a time range · BetaGetSuperAgentChatFiles #
Ask an LLM
“Can I pull files produced in super agent chats between two dates?”
“Which super agent chat files were created in a given period?”
Tell an agent
Get super agent chat files from {start_datetime} to {end_datetime}.
List super agent chat files since {start_datetime}.
POST /saved_prompts Save a new prompt · CreateSavedPrompt #
Ask an LLM
“How do I save a prompt I reuse often?”
“Can I share a saved prompt with the rest of my project?”
Tell an agent
Save prompt {prompt} as {name}.
Create shared saved prompt {name} with text {prompt}.
GET /saved_prompts List saved prompts · ListSavedPrompts #
Ask an LLM
“What saved prompts does my project have?”
“Can I page through the project's saved prompts?”
Tell an agent
List saved prompts.
Show page {page} of saved prompts.
POST /saved_prompts/{saved_prompt_id}/update Update a saved prompt · UpdateSavedPrompt #
Ask an LLM
“How do I edit the text of an existing saved prompt?”
“Can I stop sharing a saved prompt?”
Tell an agent
Change saved prompt {saved_prompt_id} text to {prompt}.
Rename saved prompt {saved_prompt_id} to {name}.
POST /saved_prompts/{saved_prompt_id}/delete Delete a saved prompt · DeleteSavedPrompt #
Ask an LLM
“How do I delete a saved prompt?”
“Can I remove a prompt I no longer use?”
Tell an agent destructive · confirm first
Delete saved prompt {saved_prompt_id}.
Remove the saved prompt {saved_prompt_id}.
POST /slide_show Create a standalone slideshow · CreateSlideshow #
Ask an LLM
“How do I create a new slideshow outside of a chat?”
“Can I set the slide order when creating a slideshow?”
Tell an agent
Create a new slideshow.
Create a slideshow with content {content} in order {order}.
GET /slide_show List my slideshows · ListUsersSlideshows #
Ask an LLM
“Which slideshows have I made?”
“Can I page through my slideshows with a preview of the first slide?”
Tell an agent
List my slideshows.
Show page {page} of my slideshows.
GET /chats/{task_id}/slide_show Get the slideshow for a chat · GetChatSlideShow #
Ask an LLM
“Can I get the slideshow a chat produced?”
“Where do I find the deck generated in a particular chat?”
Tell an agent
Get the slideshow for chat {task_id}.
Show the slides generated in chat {task_id}.
GET /slide_show/{slideshow_id} Get a slideshow by ID · GetSlideshow #
Ask an LLM
“How do I fetch a slideshow by its slideshow ID?”
“What does a slideshow record contain?”
Tell an agent
Get slideshow {slideshow_id}.
Open slideshow {slideshow_id}.
PATCH /slide_show/{slideshow_id}/visibility Make a slideshow public or private · UpdateSlideShowVisibility #
Ask an LLM
“Can I make a slideshow public so others can view it?”
“How do I set a slideshow back to private?”
Tell an agent
Set slideshow {slideshow_id} public to {public}.
Change the visibility of slideshow {slideshow_id} to public={public}.
PATCH /slide_show_template/{slideshow_template_id} Rename a slideshow template · UpdateSlideshowTemplate #
Ask an LLM
“Can I rename a slideshow template?”
“What can I change on a slideshow template after creating it?”
Tell an agent
Rename slideshow template {slideshow_template_id} to {name}.
Set the name of template {slideshow_template_id} to {name}.
DELETE /slide_show_template/{slideshow_template_id} Delete a slideshow template · DeleteSlideshowTemplate #
Ask an LLM
“How do I delete a slideshow template?”
“Can I remove a template I made from a slideshow?”
Tell an agent destructive · confirm first
Delete slideshow template {slideshow_template_id}.
Remove the slideshow template {slideshow_template_id}.
POST /slide_show/{slideshow_id}/export Export a slideshow as PDF or PNG · ExportSlideShow #
Ask an LLM
“Can I export a slideshow as a PDF?”
“Is it possible to export only certain slides as PNG images?”
Tell an agent
Export slideshow {slideshow_id} as {type}.
Export slides {slide_ids} of slideshow {slideshow_id} as {type}.
POST /slide_show/{slideshow_id}/reorder Reorder slides in a slideshow · ReorderSlides #
Ask an LLM
“How do I change the order of slides in a deck?”
“Can I move slides around in an existing slideshow?”
Tell an agent
Reorder slideshow {slideshow_id} to {slide_order}.
Put the slides of {slideshow_id} in order {slide_order}.
POST /slide_show_template Create a template from a slideshow · CreateSlideshowTemplate #
Ask an LLM
“Can I turn an existing slideshow into a reusable template?”
“How do I save a deck as a template with a name?”
Tell an agent
Create a template from slideshow {slideshow_id}.
Save slideshow {slideshow_id} as template {name}.
GET /slide_show_template List slideshow templates · ListSlideshowTemplates #
Ask an LLM
“What slideshow templates are available?”
“Which deck templates can I start from?”
Tell an agent
List slideshow templates.
Show all available deck templates.
POST /slide_show/{slideshow_id}/screenshot Screenshot a slide · TakeSlideScreenshot #
Ask an LLM
“Can I get a screenshot image of a single slide?”
“How do I capture one slide from a slideshow as an image?”
Tell an agent
Screenshot slide {slide_id} of slideshow {slideshow_id}.
Capture an image of slide {slide_id} in {slideshow_id}.
GET /slide_show_template/{slideshow_template_id}/content Get the slides in a slideshow template · GetSlideshowTemplateContent #
Ask an LLM
“What slides are inside a slideshow template?”
“Can I read a template's full content before using it?”
Tell an agent
Get the content of slideshow template {slideshow_template_id}.
Show all slides in template {slideshow_template_id}.
GET /slide_show/{slideshow_id}/versions List a slideshow's versions · ListSlideshowVersions #
Ask an LLM
“What earlier versions of a slideshow are saved?”
“Can I see a slideshow's version history?”
Tell an agent
List versions of slideshow {slideshow_id}.
Show the version history for deck {slideshow_id}.
GET /slide_show/{slideshow_id}/versions/{version_id} Get one version of a slideshow · GetSlideshowVersion #
Ask an LLM
“How do I view a specific past version of a slideshow?”
“Can I read what a deck looked like at an earlier version?”
Tell an agent
Get version {version_id} of slideshow {slideshow_id}.
Show slideshow {slideshow_id} as of version {version_id}.
POST /slide_show/{slideshow_id}/versions/{version_id}/restore Restore a slideshow to an earlier version · RestoreSlideshowVersion #
Ask an LLM
“Can I roll a slideshow back to a previous version?”
“How do I undo slide changes by restoring an older version?”
Tell an agent
Restore slideshow {slideshow_id} to version {version_id}.
Roll deck {slideshow_id} back to version {version_id}.
GET /oembed Get oEmbed data for a presentation URL · GetOEmbed #
Ask an LLM
“How do I embed a slideshow on another site using oEmbed?”
“Can I set a maximum width and height for the oEmbed response?”
Tell an agent
Get oEmbed JSON for presentation {url}.
Get oEmbed for {url} with max width {maxwidth} and max height {maxheight}.
GET /slide/{slideshow_id}/chats Get recent chats for a slideshow · GetSlideChats #
Ask an LLM
“Which chats have worked on a particular slideshow recently?”
“Can I filter a slideshow's chats by status?”
Tell an agent
Get recent chats for slideshow {slideshow_id}.
Show chats with status {statuses} on slideshow {slideshow_id}.
POST /csp_report Report a Content Security Policy violation · LogCspViolation #
Ask an LLM
“Where are browser CSP violation reports sent?”
“What fields does a report-only CSP violation need?”
Tell an agent
Log a CSP violation for directive {effectiveDirective} with disposition {disposition}.
Report blocked URL {blockedURL} under directive {effectiveDirective}, disposition {disposition}.
GET /conversations/{conversation_id}/files/list List files in a conversation · ListConversationFiles #
Ask an LLM
“Which files are attached to a conversation?”
“Can I see every file created in one conversation?”
Tell an agent
List files in conversation {conversation_id}.
Show the files for conversation {conversation_id}.
POST /conversations/{conversation_id}/files/create Add a file to a conversation · CreateConversationFile #
Ask an LLM
“How do I add a file to a conversation?”
“Can a conversation file be set to expire?”
Tell an agent
Create file {name} in conversation {conversation_id}, inferring the extension from {infer_extension_url}.
Add file {name} to conversation {conversation_id} from {infer_extension_url}, expiring after {expires_after}.
GET /conversations/{conversation_id}/files/{file_id}/get_upload_url Get an upload URL for a conversation file · GetConversationFileTemporaryUploadUrl #
Ask an LLM
“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?”
Tell an agent
Get an upload URL for file {file_id} in conversation {conversation_id}.
Give me a temporary upload link for conversation {conversation_id} file {file_id}.
GET /tasks/{workforce_task_id}/files/{file_id}/get_download_url Get a download URL for a task file · GetWorkforceTaskFileTemporaryDownloadUrl #
Ask an LLM
“How do I download a file produced by a workforce task?”
“Can I get a temporary download link for a task file?”
Tell an agent
Get a download URL for file {file_id} in task {workforce_task_id}.
Give me a temporary download link for task {workforce_task_id} file {file_id}.
GET /tasks/{workforce_task_id}/files/{file_id}/contents Read a small task file's contents · GetWorkforceTaskFileContents #
Ask an LLM
“Can I read the text contents of a workforce task file directly?”
“What size limit applies when reading a task file's contents?”
Tell an agent
Read the contents of file {file_id} in task {workforce_task_id}.
Show me what task {workforce_task_id} file {file_id} contains.
PUT /tasks/{workforce_task_id}/files/{file_id}/contents Overwrite a task session file's contents · UpdateWorkforceTaskFileContents #
Ask an LLM
“Can I edit the contents of a workforce task session file?”
“Which task files can be overwritten, and how large can they be?”
Tell an agent
Replace the contents of file {file_id} in task {workforce_task_id} with {content}.
Write {content} into task {workforce_task_id} session file {file_id}.
POST /files Start a file upload and get a presigned URL · InitiateFileUpload #
Ask an LLM
“How do I start uploading a file and get a presigned URL?”
“What details must I declare before uploading a file?”
Tell an agent
Start uploading {filename} ({mime_type}, {size_bytes} bytes) from {upload_source}.
Get a presigned upload URL for {filename} of type {mime_type}, size {size_bytes}, source {upload_source}.
POST /files/{file_id}/confirm Confirm a file upload finished · ConfirmFileUpload #
Ask an LLM
“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?”
Tell an agent
Confirm upload of file {file_id}.
Mark file {file_id} as uploaded.
GET /voice/token Get a real-time voice transcription token · GetVoiceToken #
Ask an LLM
“How do I get a token for real-time voice input streaming?”
“Where does the temporary AssemblyAI streaming token come from?”
Tell an agent
Get a voice streaming token.
Issue a temporary AssemblyAI token for live voice input.
GET /fs/volumes Discover available filesystem volumes · FsDiscoverVolumes #
Ask an LLM
“Which filesystem volumes can I access?”
“Can I see the volumes available for a particular conversation?”
Tell an agent
List available filesystem volumes.
Discover volumes for conversation {conversation_id}.
GET /fs/list List files and folders in a volume · FsListDirectory #
Ask an LLM
“What files are in a folder on a volume?”
“Can I list a volume directory recursively?”
Tell an agent
List directory {path} on volume {vol}.
Recursively list everything under {path} on volume {vol}.
GET /fs/download-url Get a download URL for a volume file · FsGetDownloadUrl #
Ask an LLM
“How do I download a file from a volume?”
“Can I download an older version of a volume file?”
Tell an agent
Get a download URL for {path} on volume {vol}.
Get a download link for version {version_id} of {path} on {vol}.
GET /fs/metadata Get metadata for a file or folder · FsGetMetadata #
Ask an LLM
“What metadata is available for a file or folder on a volume?”
“Can I check a volume file's details without downloading it?”
Tell an agent
Get metadata for {path} on volume {vol}.
Show details of {path} in volume {vol}.
POST /fs/upload-url Get an upload URL for a volume file · FsGetUploadUrl #
Ask an LLM
“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?”
Tell an agent
Get an upload URL for {path} on volume {vol}.
Get an upload link for {path} on {vol} with content type {content_type}.
POST /fs/mkdir Create a directory in a volume · FsMkdir #
Ask an LLM
“How do I create a folder on a volume?”
“Can I make a new directory path on a volume?”
Tell an agent
Create directory {path} on volume {vol}.
Make folder {path} in {vol}.
POST /fs/move Move or rename a file · FsMove #
Ask an LLM
“How do I rename a file on a volume?”
“Can I move a file from one volume to another?”
Tell an agent
Rename {source} to {destination} within volume {vol}.
Transfer {source} from {vol} across to a different volume {destination_vol} at {destination}.
GET /fs/versions List a file's version history · FsListVersions #
Ask an LLM
“What earlier versions of a volume file exist?”
“Can I page through a file's version history?”
Tell an agent
List versions of {path} on volume {vol}.
Show the last {limit} versions of {path} on {vol}.
POST /fs/restore-version Restore a file to a previous version · FsRestoreVersion #
Ask an LLM
“Can I restore a volume file to an earlier version?”
“How do I undo changes to a file on a volume?”
Tell an agent
Restore {path} on volume {vol} to version {version_id}.
Roll file {path} in {vol} back to version {version_id}.
POST /fs/delete Delete a file or directory · FsDelete #
Ask an LLM
“How do I delete a file from a volume?”
“Does deleting a folder on a volume remove everything inside it?”
Tell an agent destructive · confirm first
Delete {path} on volume {vol}.
Recursively delete folder {path} from {vol}.
GET /fs/streaming-token Get a token for real-time volume change events · FsGetStreamingToken #
Ask an LLM
“Can I subscribe to real-time change events on a volume?”
“How do I get a streaming token scoped to a filesystem volume?”
Tell an agent
Get a streaming token for volume {vol}.
Watch volume {vol} for file changes.
POST /skills/create Create a stored skill · CreateSkill #
Ask an LLM
“How do I create a reusable skill for my agents?”
“Can I describe when a skill should be used?”
Tell an agent
Create skill {skill_name} in scope {scope} described as {description} with content {content}.
Add a new {scope} skill {skill_name}: {description}, used when {when_to_use}, content {content}.
POST /skills/update Update an existing stored skill · UpdateSkill #
Ask an LLM
“How do I edit a skill I already created?”
“Can I change an existing skill's content and description?”
Tell an agent
Update existing skill {skill_name} in scope {scope} with description {description} and content {content}.
Revise the {scope} skill {skill_name}: new description {description}, new content {content}.
POST /skills/delete Delete a stored skill · DeleteSkill #
Ask an LLM
“How do I delete a stored skill?”
“Can I remove a skill from a scope?”
Tell an agent destructive · confirm first
Delete skill {skill_name} from scope {scope}.
Remove the {scope} skill {skill_name}.
GET /skills/read Read a stored skill's content · ReadSkill #
Ask an LLM
“How do I read the content of one stored skill?”
“Can I read another user's skill in a scope?”
Tell an agent
Read skill {skill_name} in scope {scope}.
Show the content of skill {skill_name} for user {user_id}.
GET /skills/list List stored skills in a scope · ListSkills #
Ask an LLM
“Which skills are stored in a scope?”
“What skills have been saved for my agents?”
Tell an agent
List stored skills.
List the skills in scope {scope}.

Documentation

📖
Documentation
https://relevanceai.com/docs
📖
APIReference
https://api-f1db6c.stack.tryrelevance.com/latest/documentation
📖
Authentication
https://artifacts.apis.io/relevance-ai/authentication/relevance-ai-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/relevance-ai/openapi/relevance-ai-chat-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://artifacts.apis.io/relevance-ai/errors/relevance-ai-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/relevance-ai/data-model/relevance-ai-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/relevance-ai:relevance-ai-chat-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

relevance-ai-chat-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Relevance AI Endpoints
  title: Relevance AI Endpoints Chat API
  version: latest
  contact:
    email: dev@tryrelevance.com
servers:
- url: /latest
security:
- AuthorizationHeader:
  - Authorization
tags:


# --- truncated at 32 KB (16881 KB total) ---
# Full source: https://artifacts.apis.io/relevance-ai/openapi/relevance-ai-chat-api-openapi.yml