# 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 Studios API version: 1.0.0 extends: openapi/relevance-ai-studios-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: 46 - target: $.paths['/auth/oauth/{account_id}/link/tool'].post update: x-apievangelist-phrasing: intent: Link a connected OAuth account to a tool effect: write questions: - 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? instructions: - text: Link OAuth account {account_id} to tool {tool_id} with link type {link_type}. slots: account_id: path.account_id tool_id: requestBody.tool_id link_type: requestBody.link_type - text: Connect my OAuth account {account_id} to the tool {tool_id}. slots: account_id: path.account_id tool_id: requestBody.tool_id method: generated generated: '2026-09-26' - target: $.paths['/auth/oauth/{account_id}/link/tool/delete'].post update: x-apievangelist-phrasing: intent: Unlink an OAuth account from a tool effect: destructive questions: - 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? instructions: - text: Remove the link between OAuth account {account_id} and tool {tool_id}. slots: account_id: path.account_id tool_id: requestBody.tool_id - text: Stop tool {tool_id} from using OAuth account {account_id}. slots: tool_id: requestBody.tool_id account_id: path.account_id method: generated generated: '2026-09-26' - target: $.paths['/studios/selector/populate'].post update: x-apievangelist-phrasing: intent: Populate options for an API selector field effect: read questions: - 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? instructions: - text: Populate the API selector options for selector type {api_selector_type}. slots: api_selector_type: requestBody.api_selector_type - text: Load the dropdown values for a tool's API selector field. method: generated generated: '2026-09-26' - target: $.paths['/studios/list'].get update: x-apievangelist-phrasing: intent: List the tools in my project effect: read questions: - What tools have I built in my Relevance AI project? - Can I list only the tools a particular user created? - Is there a way to include run metrics and share links when listing my tools? instructions: - text: List all tools in my project with page size {page_size}. slots: page_size: query.page_size - text: List the tools created by user {created_by_user}, including metrics. slots: created_by_user: query.created_by_user - text: Search my project's tools for {query} and include their OpenAPI schemas. slots: query: query.query method: generated generated: '2026-09-26' - target: $.paths['/studios/list/view'].post update: x-apievangelist-phrasing: intent: Browse tools in a sortable list view effect: read questions: - 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? instructions: - text: Show the tools list view page {page}, sorted by {sort}. slots: page: requestBody.page sort: requestBody.sort - text: Show the tools view filtered by the text {query}, ignoring folders. slots: query: requestBody.query method: generated generated: '2026-09-26' - target: $.paths['/studios/list/view/folder-aware'].post update: x-apievangelist-phrasing: intent: Browse tools in a folder-aware list view effect: read questions: - Can I list my tools grouped by the folders they're organized into? - Does the tools view respect my folder structure? instructions: - text: Show my tools organized by folder, page {page}. slots: page: requestBody.page - text: Search the folder-aware tools view for {query}. slots: query: requestBody.query method: generated generated: '2026-09-26' - target: $.paths['/studios/run_history/list'].get update: x-apievangelist-phrasing: intent: List the run history of my tools effect: read questions: - Where can I see past runs of my tools? - Can the tool run history include which agent triggered each run? instructions: - text: List my recent tool runs with studio and agent details. - text: Show tool run history page {page} with {page_size} runs per page. slots: page: query.page page_size: query.page_size method: generated generated: '2026-09-26' - target: $.paths['/studios/bulk_in_progress/list'].get update: x-apievangelist-phrasing: intent: List tools with bulk runs in progress effect: read questions: - Which of my tools currently have bulk runs still in progress? - Can I check which bulk tool jobs haven't finished yet? instructions: - text: List tools that have bulk runs in progress, with tool details. - text: Show in-progress bulk tool runs, page {page}. slots: page: query.page method: generated generated: '2026-09-26' - target: $.paths['/studios/list_public'].get update: x-apievangelist-phrasing: intent: List publicly shared tools effect: read questions: - What public tools are available that other people have shared? - Can I browse public tools available in a specific region? instructions: - text: List public tools in regions {regions}. slots: regions: query.regions - text: Search public tools for {query}. slots: query: query.query method: generated generated: '2026-09-26' - target: $.paths['/studios/{studio_id}/get_public'].get update: x-apievangelist-phrasing: intent: Get a public tool's configuration effect: read questions: - How do I look up the configuration of a public tool someone else shared? - Can I fetch a specific version of a public tool? instructions: - text: Get the public tool {studio_id}. slots: studio_id: path.studio_id - text: Fetch public tool {studio_id} from project {project}. slots: studio_id: path.studio_id project: query.project method: generated generated: '2026-09-26' - target: $.paths['/tools/{studio_id}/versions/list_public'].get update: x-apievangelist-phrasing: intent: List published versions of a public tool effect: read questions: - Which published versions exist for a public tool? - Can I see version history for a tool shared publicly? instructions: - text: List the published versions of public tool {studio_id}. slots: studio_id: path.studio_id - text: Show up to {page_size} public versions for tool {studio_id}. slots: page_size: query.page_size studio_id: path.studio_id method: generated generated: '2026-09-26' - target: $.paths['/studios/{studio_id}/get'].get update: x-apievangelist-phrasing: intent: Get one of my tools effect: read questions: - 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? instructions: - text: Get my tool {studio_id}. slots: studio_id: path.studio_id - text: Show tool {studio_id} at version {version}. slots: studio_id: path.studio_id version: query.version method: generated generated: '2026-09-26' - target: $.paths['/studios/bulk_update'].post update: x-apievangelist-phrasing: intent: Update several tools at once effect: write questions: - Can I apply changes to many tools in a single request? - Is a partial update supported when bulk editing tools? instructions: - text: 'Apply these tool updates in bulk: {updates}.' slots: updates: requestBody.updates - text: Bulk update my tools with {updates} as a partial update. slots: updates: requestBody.updates method: generated generated: '2026-09-26' - target: $.paths['/studios/bulk_delete'].post update: x-apievangelist-phrasing: intent: Delete several tools at once effect: destructive questions: - How do I delete a batch of tools in one go? - Can I remove multiple tools by their IDs at the same time? instructions: - text: Delete the tools {ids}. slots: ids: requestBody.ids - text: 'Bulk delete these tool IDs from my project: {ids}.' slots: ids: requestBody.ids method: generated generated: '2026-09-26' - target: $.paths['/studios/{studio_id}/trigger'].post update: x-apievangelist-phrasing: intent: Run a tool and wait for the result effect: write questions: - 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? instructions: - text: Run tool {studio_id} with inputs {params}. slots: studio_id: path.studio_id params: requestBody.params - text: Execute tool {studio_id} synchronously and return the output. slots: studio_id: path.studio_id method: generated generated: '2026-09-26' - target: $.paths['/studios/{studio_id}/trigger_llm_friendly'].post update: x-apievangelist-phrasing: intent: Run a tool with LLM-friendly output effect: write questions: - 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? instructions: - text: Run tool {studio_id} and return LLM-friendly output. slots: studio_id: path.studio_id - text: Trigger tool {studio_id} in the LLM-friendly format for my agent. slots: studio_id: path.studio_id method: generated generated: '2026-09-26' - target: $.paths['/studios/{job_id}/cancel'].post update: x-apievangelist-phrasing: intent: Cancel a running tool job effect: destructive questions: - How do I stop a tool run that is still going? - Can I cancel a tool job by its job ID? instructions: - text: Cancel tool job {job_id}. slots: job_id: path.job_id - text: Stop the running tool job {job_id} now. slots: job_id: path.job_id method: generated generated: '2026-09-26' - target: $.paths['/studios/{studio_id}/trigger_async'].post update: x-apievangelist-phrasing: intent: Start a tool run in the background effect: write questions: - 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? instructions: - text: Start tool {studio_id} asynchronously with inputs {params}. slots: studio_id: path.studio_id params: requestBody.params - text: Queue a background run of tool {studio_id} and give me the job ID. slots: studio_id: path.studio_id method: generated generated: '2026-09-26' - target: $.paths['/studios/{studio_id}/async_poll/{job_id}'].get update: x-apievangelist-phrasing: intent: Check the progress of a background tool run effect: read questions: - How do I check whether my asynchronous tool run has finished? - Can I poll only for the final update of a background tool job? instructions: - text: Poll job {job_id} for tool {studio_id}. slots: job_id: path.job_id studio_id: path.studio_id - text: Get updates for job {job_id} of tool {studio_id} after message {after_message_id}. slots: job_id: path.job_id studio_id: path.studio_id after_message_id: query.after_message_id method: generated generated: '2026-09-26' - target: $.paths['/studios/{studio_id}/trigger_limited'].post update: x-apievangelist-phrasing: intent: Run a tool with limited trigger options effect: write questions: - 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? instructions: - text: Run tool {studio_id} in project {project} with inputs {params} using the limited trigger. slots: studio_id: path.studio_id project: requestBody.project params: requestBody.params - text: Do a limited synchronous run of tool {studio_id} for project {project}. slots: studio_id: path.studio_id project: requestBody.project method: generated generated: '2026-09-26' - target: $.paths['/studios/{studio_id}/trigger_limited_async'].post update: x-apievangelist-phrasing: intent: Start a limited tool run in the background effect: write questions: - Is there a limited trigger that runs a tool asynchronously? - Can I queue a tool run with just project and params and poll later? instructions: - text: Start a limited async run of tool {studio_id} in project {project} with inputs {params}. slots: studio_id: path.studio_id project: requestBody.project params: requestBody.params - text: Queue tool {studio_id} for project {project} via the limited async trigger. slots: studio_id: path.studio_id project: requestBody.project method: generated generated: '2026-09-26' - target: $.paths['/studios/{studio_id}/trigger_webhook'].post update: x-apievangelist-phrasing: intent: Trigger a public tool from a webhook effect: write questions: - Can an external webhook call start one of my tools? - Does a tool need to be publicly triggerable to run it from a webhook? instructions: - text: Trigger tool {studio_id} via its webhook. slots: studio_id: path.studio_id - text: Fire the webhook trigger for tool {studio_id} in project {project}. slots: studio_id: path.studio_id project: query.project method: generated generated: '2026-09-26' - target: $.paths['/studios/transformations/list'].get update: x-apievangelist-phrasing: intent: List available tool step types effect: read questions: - What built-in tool steps can I add to a tool? - Can I filter tool steps by integration or use case? - Which tool steps are marked legacy? instructions: - text: List tool steps for the integration {integration}. slots: integration: query.integration - text: Search tool step types for {query} using semantic search. slots: query: query.query method: generated generated: '2026-09-26' - target: $.paths['/studios/transformations/{id}/get'].get update: x-apievangelist-phrasing: intent: Get a tool step definition effect: read questions: - How do I see the inputs and outputs of one specific tool step? - Can I fetch a tool step definition by its ID? instructions: - text: Get the tool step {id}. slots: id: path.id - text: Show the definition of transformation {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/studios/tool_steps/all/list'].get update: x-apievangelist-phrasing: intent: List tool steps including public tools effect: read questions: - 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? instructions: - text: List all tool steps and public tools in category {category}. slots: category: query.category - text: Find steps or public tools matching {query}. slots: query: query.query method: generated generated: '2026-09-26' - target: $.paths['/studios/by_share_id/{share_id}'].post update: x-apievangelist-phrasing: intent: Open a tool from a share link effect: read questions: - 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? instructions: - text: Get the tool shared under share ID {share_id}. slots: share_id: path.share_id - text: Load version {version} of the shared tool {share_id}. slots: version: query.version share_id: path.share_id method: generated generated: '2026-09-26' - target: $.paths['/studios/{studio_id}/get_share_link'].post update: x-apievangelist-phrasing: intent: Create a share link for a tool effect: write questions: - 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? instructions: - text: Create a share link for tool {studio_id}. slots: studio_id: path.studio_id - text: Get a share link for version {version} of tool {studio_id}. slots: version: requestBody.version studio_id: path.studio_id method: generated generated: '2026-09-26' - target: $.paths['/studios/{studio_id}/delete_share_link'].post update: x-apievangelist-phrasing: intent: Revoke a tool's share link effect: destructive questions: - How do I stop a shared tool link from working? - Can I revoke one specific share link without affecting the tool? instructions: - text: Delete share link {share_id} for tool {studio_id}. slots: share_id: requestBody.share_id studio_id: path.studio_id - text: Revoke the share link {share_id} on tool {studio_id}. slots: share_id: requestBody.share_id studio_id: path.studio_id method: generated generated: '2026-09-26' - target: $.paths['/studios/clone'].post update: x-apievangelist-phrasing: intent: Duplicate a tool with its subtools effect: write questions: - 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? - Is it possible to clone a tool into a different project or region? instructions: - text: Clone tool {studio_id}. slots: studio_id: requestBody.studio_id - text: Clone tool {studio_id} into project {project} in region {region}. slots: studio_id: requestBody.studio_id project: requestBody.project region: requestBody.region method: generated generated: '2026-09-26' - target: $.paths['/tools/versions/{version_id}/get'].get update: x-apievangelist-phrasing: intent: Get a specific tool version effect: read questions: - How do I view the config saved in one particular tool version? - Can I fetch a tool version directly by its version ID? instructions: - text: Get tool version {version_id}. slots: version_id: path.version_id - text: Show me what's saved in version {version_id}. slots: version_id: path.version_id method: generated generated: '2026-09-26' - target: $.paths['/tools/versions/list'].post update: x-apievangelist-phrasing: intent: List all versions of one of my tools effect: read questions: - What versions have been saved for my tool? - Can I page through the version history of a tool in my project? instructions: - text: List all versions of my tool {tool_id}. slots: tool_id: requestBody.tool_id - text: Show {page_size} versions of tool {tool_id} per page. slots: page_size: requestBody.page_size tool_id: requestBody.tool_id method: generated generated: '2026-09-26' - target: $.paths['/tools/versions/upsert'].post update: x-apievangelist-phrasing: intent: Create or update a tool version effect: write questions: - 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? instructions: - text: Upsert a version of tool {tool_id} named {name}. slots: tool_id: requestBody.tool_id name: requestBody.name - text: Update version {version_id} of tool {tool_id} with config {config}. slots: version_id: requestBody.version_id tool_id: requestBody.tool_id config: requestBody.config method: generated generated: '2026-09-26' - target: $.paths['/studios/legacy_migration/discover'].post update: x-apievangelist-phrasing: intent: Find legacy steps in a tool that can be upgraded effect: read questions: - Which Pipedream-backed steps in my tool have native replacements? - Can I see legacy tool steps grouped by integration provider before upgrading? instructions: - text: Find legacy tool steps in tool {studio_id} that have native replacements. slots: studio_id: requestBody.studio_id - text: Check tool {studio_id} for Pipedream steps I can upgrade. slots: studio_id: requestBody.studio_id method: generated generated: '2026-09-26' - target: $.paths['/tools/versions/draft'].post update: x-apievangelist-phrasing: intent: Save changes to a tool as a draft effect: write questions: - How do I save edits to a tool without publishing them? - What happens to an existing draft when I save a new one? instructions: - text: Save tool {studio_id} as a draft. slots: studio_id: requestBody.studio_id - text: Save a draft of tool {studio_id} with the title {title}. slots: studio_id: requestBody.studio_id title: requestBody.title method: generated generated: '2026-09-26' - target: $.paths['/tools/versions/publish'].post update: x-apievangelist-phrasing: intent: Publish a tool's draft as the active version effect: write questions: - How do I make my draft tool version live? - Can I promote the current draft to be the active version of a tool? instructions: - text: Publish the current draft of tool {tool_id}. slots: tool_id: requestBody.tool_id - text: Make tool {tool_id}'s draft the active version. slots: tool_id: requestBody.tool_id method: generated generated: '2026-09-26' - target: $.paths['/tools/versions/bulk_delete'].post update: x-apievangelist-phrasing: intent: Delete several tool versions effect: destructive questions: - Can I clean up old tool versions in bulk? - Is there a way to delete multiple tool versions by ID? instructions: - text: Delete tool versions {version_ids}. slots: version_ids: requestBody.version_ids - text: 'Remove these old tool versions: {version_ids}.' slots: version_ids: requestBody.version_ids method: generated generated: '2026-09-26' - target: $.paths['/tools/versions/restore'].post update: x-apievangelist-phrasing: intent: Restore an old tool version as the draft effect: write questions: - 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? instructions: - text: Restore tool version {version_id} as the current draft. slots: version_id: requestBody.version_id - text: Roll back to version {version_id} by duplicating it into a draft. slots: version_id: requestBody.version_id method: generated generated: '2026-09-26' - target: $.paths['/studios/search/cag'].post update: x-apievangelist-phrasing: intent: Search tools, steps, templates and agents effect: read questions: - 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? instructions: - text: Search tools, tool steps and agents for {query}. slots: query: requestBody.query - text: Find the top {number_of_results} tools or agents matching {query}. slots: number_of_results: requestBody.number_of_results query: requestBody.query method: generated generated: '2026-09-26' - target: $.paths['/studios/reload_pipedream_props'].post update: x-apievangelist-phrasing: intent: Reload dynamic props for a Pipedream action effect: read questions: - Which reloadable properties does a Pipedream action step expose? - Can I refresh the dynamic input options of an integration action step? instructions: - text: Reload props for Pipedream action {transformation_name} from provider {provider_name}. slots: transformation_name: requestBody.transformation_name provider_name: requestBody.provider_name - text: List reloadable props for step {transformation_id} given inputs {inputProperties}. slots: transformation_id: requestBody.transformation_id inputProperties: requestBody.inputProperties method: generated generated: '2026-09-26' - target: $.paths['/tools/{studio_id}/display-output/generate'].post update: x-apievangelist-phrasing: intent: Generate a display output for a tool effect: write questions: - 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? instructions: - text: Generate a display output for tool {studio_id} from output {action_output}. slots: studio_id: path.studio_id action_output: requestBody.action_output - text: Draft a display output for tool {studio_id} using prompts {prompts}. slots: studio_id: path.studio_id prompts: requestBody.prompts method: generated generated: '2026-09-26' - target: $.paths['/tools/{studio_id}/display-output/generate'].patch update: x-apievangelist-phrasing: intent: Apply a generated display output to a tool effect: write questions: - How do I save the generated display output onto my tool? - What signature is needed to apply a display output? instructions: - text: Apply the generated display output {content} to tool {studio_id}. slots: content: requestBody.content studio_id: path.studio_id - text: Attach display output of type {type} with signature {signature} to tool {studio_id}. slots: type: requestBody.type signature: requestBody.signature studio_id: path.studio_id method: generated generated: '2026-09-26' - target: $.paths['/tools/{studio_id}/display-output'].delete update: x-apievangelist-phrasing: intent: Remove a tool's display output effect: destructive questions: - Can I remove the custom display output from a tool? - How do I revert a tool to showing raw output? instructions: - text: Delete the display output from tool {studio_id}. slots: studio_id: path.studio_id - text: Remove the custom results display on tool {studio_id}. slots: studio_id: path.studio_id method: generated generated: '2026-09-26' - target: $.paths['/studios/errors/explain'].post update: x-apievangelist-phrasing: intent: Explain an error from a tool run effect: read questions: - Why did my tool run fail, in plain language? - Can I get an explanation of a tool error given the tool schema? instructions: - text: 'Explain this tool run error: {error_info}.' slots: error_info: requestBody.error_info - text: Explain error {error_info} for the tool with schema {tool_schema}. slots: error_info: requestBody.error_info tool_schema: requestBody.tool_schema method: generated generated: '2026-09-26' - target: $.paths['/studios/list/usage'].get update: x-apievangelist-phrasing: intent: List tools with their usage totals effect: read questions: - Which of my tools get used the most? - Can I see usage information alongside every tool in my project? instructions: - text: List all my tools with their usage information. - text: Show usage aggregates for every tool in the project. method: generated generated: '2026-09-26' - target: $.paths['/studios/transformations/recently_used'].get update: x-apievangelist-phrasing: intent: List recently used tool steps effect: read questions: - What tool steps have I used recently? - Can I page through my recently used steps with a cursor? instructions: - text: Show my recently used tool steps. - text: List the next {page_size} recently used steps after cursor {cursor}. slots: page_size: query.page_size cursor: query.cursor method: generated generated: '2026-09-26' - target: $.paths['/studios/count'].get update: x-apievangelist-phrasing: intent: Count the tools in a project effect: read questions: - How many tools are there in my project? - Is there a quick way to get the total tool count? instructions: - text: Count the tools in my project. - text: Tell me the total number of tools I have. method: generated generated: '2026-09-26'