Relevance AI Studios API
The studios API from Relevance AI — 45 operation(s) for studios.
Operations 46
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
POST
/auth/oauth/{account_id}/link/tool
Link a connected OAuth account to a tool · UpsertOAuthAccountToolLink
#
Ask an LLM
“How do I attach one of my connected OAuth accounts to a specific tool?”
“Can a tool be set to always use a particular OAuth account I've connected?”
Tell an agent
Link OAuth account {account_id} to tool {tool_id} with link type {link_type}.
Connect my OAuth account {account_id} to the tool {tool_id}.
POST
/auth/oauth/{account_id}/link/tool/delete
Unlink an OAuth account from a tool · DeleteOAuthAccountToolLink
#
Ask an LLM
“Can I detach a connected OAuth account from a tool so it stops using those credentials?”
“What happens when I remove the link between an OAuth account and a tool?”
Tell an agent destructive · confirm first
Remove the link between OAuth account {account_id} and tool {tool_id}.
Stop tool {tool_id} from using OAuth account {account_id}.
Ask an LLM
“Which options are available to fill an API selector input in a tool?”
“Can I load the choices for a studio API selector of a given type?”
Tell an agent
Populate the API selector options for selector type {api_selector_type}.
Load the dropdown values for a tool's API selector field.
Ask an LLM
“What tools have I built in my Relevance AI project?”
“Can I list only the tools a particular user created?”
Tell an agent
List all tools in my project with page size {page_size}.
List the tools created by user {created_by_user}, including metrics.
Ask an LLM
“Can I get my tools as a paged, sorted view like the tools page shows?”
“Which view lists my tools sorted by a field with a search box?”
Tell an agent
Show the tools list view page {page}, sorted by {sort}.
Show the tools view filtered by the text {query}, ignoring folders.
POST
/studios/list/view/folder-aware
Browse tools in a folder-aware list view · ListStudiosFoldersAwareView
#
Ask an LLM
“Can I list my tools grouped by the folders they're organized into?”
“Does the tools view respect my folder structure?”
Tell an agent
Show my tools organized by folder, page {page}.
Search the folder-aware tools view for {query}.
Ask an LLM
“Where can I see past runs of my tools?”
“Can the tool run history include which agent triggered each run?”
Tell an agent
List my recent tool runs with studio and agent details.
Show tool run history page {page} with {page_size} runs per page.
GET
/studios/bulk_in_progress/list
List tools with bulk runs in progress · ListBulkInProgressStudios
#
Ask an LLM
“Which of my tools currently have bulk runs still in progress?”
“Can I check which bulk tool jobs haven't finished yet?”
Tell an agent
List tools that have bulk runs in progress, with tool details.
Show in-progress bulk tool runs, page {page}.
Ask an LLM
“What public tools are available that other people have shared?”
“Can I browse public tools available in a specific region?”
Tell an agent
List public tools in regions {regions}.
Search public tools for {query}.
Ask an LLM
“How do I look up the configuration of a public tool someone else shared?”
“Can I fetch a specific version of a public tool?”
Tell an agent
Get the public tool {studio_id}.
Fetch public tool {studio_id} from project {project}.
GET
/tools/{studio_id}/versions/list_public
List published versions of a public tool · ListPublicToolVersions
#
Ask an LLM
“Which published versions exist for a public tool?”
“Can I see version history for a tool shared publicly?”
Tell an agent
List the published versions of public tool {studio_id}.
Show up to {page_size} public versions for tool {studio_id}.
Ask an LLM
“How do I get the full configuration of one of my own tools?”
“Can I retrieve a particular version of a tool in my project?”
Tell an agent
Get my tool {studio_id}.
Show tool {studio_id} at version {version}.
Ask an LLM
“Can I apply changes to many tools in a single request?”
“Is a partial update supported when bulk editing tools?”
Tell an agent
Apply these tool updates in bulk: {updates}.
Bulk update my tools with {updates} as a partial update.
Ask an LLM
“How do I delete a batch of tools in one go?”
“Can I remove multiple tools by their IDs at the same time?”
Tell an agent destructive · confirm first
Delete the tools {ids}.
Bulk delete these tool IDs from my project: {ids}.
Ask an LLM
“How do I run one of my tools and get its output back in the same call?”
“Can I pass input parameters when running a tool synchronously?”
Tell an agent
Run tool {studio_id} with inputs {params}.
Execute tool {studio_id} synchronously and return the output.
POST
/studios/{studio_id}/trigger_llm_friendly
Run a tool with LLM-friendly output · TriggerStudioLLMFriendly
#
Ask an LLM
“Is there a way to run a tool so the response is easy for an LLM to read?”
“Which endpoint returns tool output formatted for language models?”
Tell an agent
Run tool {studio_id} and return LLM-friendly output.
Trigger tool {studio_id} in the LLM-friendly format for my agent.
Ask an LLM
“How do I stop a tool run that is still going?”
“Can I cancel a tool job by its job ID?”
Tell an agent destructive · confirm first
Cancel tool job {job_id}.
Stop the running tool job {job_id} now.
Ask an LLM
“Can I start a long-running tool without waiting for it to finish?”
“How do I kick off a tool asynchronously and get a job ID to poll?”
Tell an agent
Start tool {studio_id} asynchronously with inputs {params}.
Queue a background run of tool {studio_id} and give me the job ID.
GET
/studios/{studio_id}/async_poll/{job_id}
Check the progress of a background tool run · StudioAsyncPoll
#
Ask an LLM
“How do I check whether my asynchronous tool run has finished?”
“Can I poll only for the final update of a background tool job?”
Tell an agent
Poll job {job_id} for tool {studio_id}.
Get updates for job {job_id} of tool {studio_id} after message {after_message_id}.
POST
/studios/{studio_id}/trigger_limited
Run a tool with limited trigger options · TriggerStudioLimited
#
Ask an LLM
“Can I run a tool by passing only its project and inputs, without extra executor settings?”
“What's the restricted way to trigger a tool synchronously?”
Tell an agent
Run tool {studio_id} in project {project} with inputs {params} using the limited trigger.
Do a limited synchronous run of tool {studio_id} for project {project}.
POST
/studios/{studio_id}/trigger_limited_async
Start a limited tool run in the background · TriggerStudioLimitedAsync
#
Ask an LLM
“Is there a limited trigger that runs a tool asynchronously?”
“Can I queue a tool run with just project and params and poll later?”
Tell an agent
Start a limited async run of tool {studio_id} in project {project} with inputs {params}.
Queue tool {studio_id} for project {project} via the limited async trigger.
POST
/studios/{studio_id}/trigger_webhook
Trigger a public tool from a webhook · TriggerStudioFromWebhook
#
Ask an LLM
“Can an external webhook call start one of my tools?”
“Does a tool need to be publicly triggerable to run it from a webhook?”
Tell an agent
Trigger tool {studio_id} via its webhook.
Fire the webhook trigger for tool {studio_id} in project {project}.
Ask an LLM
“What built-in tool steps can I add to a tool?”
“Can I filter tool steps by integration or use case?”
Tell an agent
List tool steps for the integration {integration}.
Search tool step types for {query} using semantic search.
Ask an LLM
“How do I see the inputs and outputs of one specific tool step?”
“Can I fetch a tool step definition by its ID?”
Tell an agent
Get the tool step {id}.
Show the definition of transformation {id}.
Ask an LLM
“Can I see transformations and public tools together as a single list of steps?”
“Which steps are available in a given category, including public tools?”
Tell an agent
List all tool steps and public tools in category {category}.
Find steps or public tools matching {query}.
Ask an LLM
“Someone sent me a tool share link — how do I load its config?”
“Can I look up a tool using just its share link ID?”
Tell an agent
Get the tool shared under share ID {share_id}.
Load version {version} of the shared tool {share_id}.
Ask an LLM
“How do I get a link to share one of my tools with others?”
“Can I generate a share link for a particular version of a tool?”
Tell an agent
Create a share link for tool {studio_id}.
Get a share link for version {version} of tool {studio_id}.
Ask an LLM
“How do I stop a shared tool link from working?”
“Can I revoke one specific share link without affecting the tool?”
Tell an agent destructive · confirm first
Delete share link {share_id} for tool {studio_id}.
Revoke the share link {share_id} on tool {studio_id}.
Ask an LLM
“Can I make a copy of a tool including the subtools it uses?”
“How many levels of subtools get copied when I clone a tool?”
Tell an agent
Clone tool {studio_id}.
Clone tool {studio_id} into project {project} in region {region}.
Ask an LLM
“How do I view the config saved in one particular tool version?”
“Can I fetch a tool version directly by its version ID?”
Tell an agent
Get tool version {version_id}.
Show me what's saved in version {version_id}.
Ask an LLM
“What versions have been saved for my tool?”
“Can I page through the version history of a tool in my project?”
Tell an agent
List all versions of my tool {tool_id}.
Show {page_size} versions of tool {tool_id} per page.
Ask an LLM
“Can I save a tool version that is created if missing and merged if it exists?”
“Does updating a tool version overwrite fields I leave out?”
Tell an agent
Upsert a version of tool {tool_id} named {name}.
Update version {version_id} of tool {tool_id} with config {config}.
POST
/studios/legacy_migration/discover
Find legacy steps in a tool that can be upgraded · DiscoverStudioLegacyToolSteps
#
Ask an LLM
“Which Pipedream-backed steps in my tool have native replacements?”
“Can I see legacy tool steps grouped by integration provider before upgrading?”
Tell an agent
Find legacy tool steps in tool {studio_id} that have native replacements.
Check tool {studio_id} for Pipedream steps I can upgrade.
Ask an LLM
“How do I save edits to a tool without publishing them?”
“What happens to an existing draft when I save a new one?”
Tell an agent
Save tool {studio_id} as a draft.
Save a draft of tool {studio_id} with the title {title}.
Ask an LLM
“How do I make my draft tool version live?”
“Can I promote the current draft to be the active version of a tool?”
Tell an agent
Publish the current draft of tool {tool_id}.
Make tool {tool_id}'s draft the active version.
Ask an LLM
“Can I clean up old tool versions in bulk?”
“Is there a way to delete multiple tool versions by ID?”
Tell an agent destructive · confirm first
Delete tool versions {version_ids}.
Remove these old tool versions: {version_ids}.
Ask an LLM
“How do I roll a tool back to an earlier version?”
“Does restoring a version overwrite it or make a copy as the new draft?”
Tell an agent
Restore tool version {version_id} as the current draft.
Roll back to version {version_id} by duplicating it into a draft.
Ask an LLM
“Can I search across my tools, marketplace tools and agents in one query?”
“How do I find the right tool step or agent for a task using cache augmented search?”
Tell an agent
Search tools, tool steps and agents for {query}.
Find the top {number_of_results} tools or agents matching {query}.
POST
/studios/reload_pipedream_props
Reload dynamic props for a Pipedream action · ListReloadPipedreamProps
#
Ask an LLM
“Which reloadable properties does a Pipedream action step expose?”
“Can I refresh the dynamic input options of an integration action step?”
Tell an agent
Reload props for Pipedream action {transformation_name} from provider {provider_name}.
List reloadable props for step {transformation_id} given inputs {inputProperties}.
POST
/tools/{studio_id}/display-output/generate
Generate a display output for a tool · GenerateToolDisplayOutput
#
Ask an LLM
“Can I have a nicer display of a tool's results generated from sample inputs and outputs?”
“How do I create a rendered output view for my tool before applying it?”
Tell an agent
Generate a display output for tool {studio_id} from output {action_output}.
Draft a display output for tool {studio_id} using prompts {prompts}.
PATCH
/tools/{studio_id}/display-output/generate
Apply a generated display output to a tool · ApplyToolDisplayOutput
#
Ask an LLM
“How do I save the generated display output onto my tool?”
“What signature is needed to apply a display output?”
Tell an agent
Apply the generated display output {content} to tool {studio_id}.
Attach display output of type {type} with signature {signature} to tool {studio_id}.
Ask an LLM
“Can I remove the custom display output from a tool?”
“How do I revert a tool to showing raw output?”
Tell an agent destructive · confirm first
Delete the display output from tool {studio_id}.
Remove the custom results display on tool {studio_id}.
Ask an LLM
“Why did my tool run fail, in plain language?”
“Can I get an explanation of a tool error given the tool schema?”
Tell an agent
Explain this tool run error: {error_info}.
Explain error {error_info} for the tool with schema {tool_schema}.
Ask an LLM
“Which of my tools get used the most?”
“Can I see usage information alongside every tool in my project?”
Tell an agent
List all my tools with their usage information.
Show usage aggregates for every tool in the project.
Ask an LLM
“What tool steps have I used recently?”
“Can I page through my recently used steps with a cursor?”
Tell an agent
Show my recently used tool steps.
List the next {page_size} recently used steps after cursor {cursor}.
Ask an LLM
“How many tools are there in my project?”
“Is there a quick way to get the total tool count?”
Tell an agent
Count the tools in my project.
Tell me the total number of tools I have.
Documentation
📖
Documentation
https://relevanceai.com/docs
📖
APIReference
https://api-f1db6c.stack.tryrelevance.com/latest/documentation
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/authentication/relevance-ai-authentication.yml