API Evangelist conversational phrasing for Relevance AI Endpoints Chat API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Relevance AI Endpoints Chat API
  version: 1.0.0
extends: openapi/relevance-ai-chat-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 171
- target: $.paths['/phone-numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone numbers assigned to the project
      effect: read
      questions:
      - Which phone numbers are assigned to my Relevance AI project?
      - Can I see only the project phone numbers from one telephony provider?
      instructions:
      - text: List every phone number assigned to this project.
      - text: Show the project phone numbers that come from provider {provider}.
        slots:
          provider: query.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Deep clone an agent with its tools and subagents
      effect: write
      questions:
      - How do I make a full copy of an agent including all its tools and subagents?
      - Can I add a name prefix to the copies when cloning an agent recursively?
      instructions:
      - text: Deep clone agent template {template} with all its tools and subagents.
        slots:
          template: requestBody.template
      - text: Clone agent {template} recursively and prefix the copied names with {prefix}.
        slots:
          template: requestBody.template
          prefix: requestBody.prefix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/clone_marketplace_template'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a marketplace agent template
      effect: write
      questions:
      - Can I copy an agent from a marketplace template into my own project?
      - What gets copied when I clone a marketplace agent template, tools and subagents too?
      instructions:
      - text: Clone marketplace template {template} into my project.
        slots:
          template: requestBody.template
      - text: Install the marketplace agent template {template} as my own agent with its tools.
        slots:
          template: requestBody.template
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update an agent's configuration
      effect: write
      questions:
      - How do I create a new agent or update an existing one without overwriting it?
      - Can I set an agent's system prompt and model in the same create-or-update call?
      - Does updating an agent's live config merge fields rather than replace the whole agent?
      instructions:
      - text: Create or update agent {agent_id} named {name}.
        slots:
          agent_id: requestBody.agent_id
          name: requestBody.name
      - text: Set the system prompt of agent {agent_id} to {system_prompt} and use model {model}.
        slots:
          agent_id: requestBody.agent_id
          system_prompt: requestBody.system_prompt
          model: requestBody.model
      - text: Change the temperature of agent {agent_id} to {temperature}.
        slots:
          agent_id: requestBody.agent_id
          temperature: requestBody.temperature
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/upsert_preset'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up a preset agent such as a meeting notetaker
      effect: write
      questions:
      - How do I add a ready-made preset agent like the meeting notetaker to my project?
      - Can I force a preset agent to be created as a brand-new agent instead of updating the existing one?
      instructions:
      - text: Set up preset agent {preset_agent_id} in my project.
        slots:
          preset_agent_id: requestBody.preset_agent_id
      - text: Install preset agent {preset_agent_id} as a new agent and sync its evals ({sync_evals}).
        slots:
          preset_agent_id: requestBody.preset_agent_id
          sync_evals: requestBody.sync_evals
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Search and filter agents in the project
      effect: read
      questions:
      - Can I search all agents in my project by keyword and filters?
      - Is there a way to include public agents when searching the agent list?
      instructions:
      - text: Search the project's agents for {query}.
        slots:
          query: requestBody.query
      - text: Find agents matching {query}, including public agents, page {page}.
        slots:
          query: requestBody.query
          page: requestBody.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/list-my-agents'].post
  update:
    x-apievangelist-phrasing:
      intent: List agents I created
      effect: read
      questions:
      - Which agents have I personally created?
      - Can I page through only my own agents, sorted my way?
      instructions:
      - text: List the agents I created.
      - text: Show my own agents, {page_size} per page, sorted by {sort}.
        slots:
          page_size: requestBody.page_size
          sort: requestBody.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent's details
      effect: read
      questions:
      - How do I fetch the full configuration of one agent?
      - Can I retrieve a specific version of an agent rather than the current one?
      instructions:
      - text: Get agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Retrieve agent {agent_id} at version {version}.
        slots:
          agent_id: path.agent_id
          version: query.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/tools/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List tools across several agents
      effect: read
      questions:
      - What tools are used by a set of agents at once?
      - Can I get a combined tools view for multiple agent IDs in one call?
      instructions:
      - text: Show the tools used by agents {agent_ids}.
        slots:
          agent_ids: requestBody.agent_ids
      - text: 'List tools for this batch of agents: {agent_ids}.'
        slots:
          agent_ids: requestBody.agent_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/tools/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the tools attached to one agent
      effect: read
      questions:
      - Which tools is a single agent allowed to use?
      - Can I include phantom tools when listing one agent's tools?
      instructions:
      - text: List the tools attached to agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Show tools for agent {agent_id} at version {agent_version}, including phantom tools.
        slots:
          agent_id: path.agent_id
          agent_version: requestBody.agent_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/dependency-versions/metadata/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List metadata for an agent's pinned dependencies
      effect: read
      questions:
      - What versions are my agent's pinned subagent dependencies on?
      - Can I get display details for the agents that another agent depends on?
      instructions:
      - text: Show pinned dependency metadata for agent {agent_id} covering {dependencies}.
        slots:
          agent_id: path.agent_id
          dependencies: requestBody.dependencies
      - text: List the pinned direct agent dependencies {dependencies} of agent {agent_id}.
        slots:
          agent_id: path.agent_id
          dependencies: requestBody.dependencies
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a message to an agent to run it
      effect: write
      questions:
      - How do I start an agent run by sending it a message through the API?
      - Can I continue an existing conversation when triggering an agent?
      - Is it possible to cap how long a triggered agent job may run?
      instructions:
      - text: Trigger agent {agent_id}.
        slots:
          agent_id: requestBody.agent_id
      - text: Send agent {agent_id} a new run in conversation {conversation_id}.
        slots:
          agent_id: requestBody.agent_id
          conversation_id: requestBody.conversation_id
      - text: Run agent {agent_id} with a max job duration of {max_job_duration}.
        slots:
          agent_id: requestBody.agent_id
          max_job_duration: requestBody.max_job_duration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/bulk_trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger an agent in bulk across rows
      effect: write
      questions:
      - Can I trigger an agent over many rows at once instead of one message at a time?
      - What limits how many rows a bulk agent trigger processes at once?
      instructions:
      - text: Bulk trigger agent {agent_id} across the matching rows.
        slots:
          agent_id: requestBody.agent_id
      - text: Bulk run agent {agent_id} with at most {max_rows_at_once} rows at once.
        slots:
          agent_id: requestBody.agent_id
          max_rows_at_once: requestBody.max_rows_at_once
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/get_embed_key'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an embed key for an agent
      effect: write
      questions:
      - How do I get a key to embed an agent on my website?
      - Where does the embed key for a single agent come from?
      instructions:
      - text: Generate an embed key for agent {agent_id} in project {project}.
        slots:
          agent_id: requestBody.agent_id
          project: requestBody.project
      - text: Give me the embed key for agent {agent_id}, project {project}.
        slots:
          agent_id: requestBody.agent_id
          project: requestBody.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent
      effect: destructive
      questions:
      - How do I permanently remove an agent from my project?
      - What happens when I delete an agent I no longer use?
      instructions:
      - text: Delete agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Remove the agent {agent_id} from the project.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/suggest_replies'].post
  update:
    x-apievangelist-phrasing:
      intent: Suggest replies to an agent's latest message
      effect: read
      questions:
      - Can I get suggested replies to the last message an agent sent in a conversation?
      - Is it possible to steer the reply suggestions with my own instructions?
      instructions:
      - text: Suggest replies for conversation {conversation_id} with agent {agent_id}.
        slots:
          conversation_id: requestBody.conversation_id
          agent_id: path.agent_id
      - text: Draft reply suggestions in conversation {conversation_id} of agent {agent_id} following {instructions}.
        slots:
          conversation_id: requestBody.conversation_id
          agent_id: path.agent_id
          instructions: requestBody.instructions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/prompt_models/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List LLMs supported for agent prompts
      effect: read
      questions:
      - Which LLMs are supported for agent prompts?
      - What prompt models can I pick when configuring an agent?
      instructions:
      - text: List the supported prompt LLMs for agents.
      - text: Show me the agent prompt model options.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/models/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List available LLMs
      effect: read
      questions:
      - What large language models are available on the platform?
      - Can I narrow the LLM catalog to a particular model subset?
      instructions:
      - text: List all available LLMs.
      - text: List LLMs in model subset {model_subset}.
        slots:
          model_subset: query.model_subset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/models/stt/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List speech-to-text models
      effect: read
      questions:
      - Which speech-to-text models can a voice agent use?
      - What transcription models are available?
      instructions:
      - text: List the speech-to-text models.
      - text: Show available STT models for voice agents.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/models/tts/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List text-to-speech models
      effect: read
      questions:
      - Which text-to-speech voices or models can my agent speak with?
      - What TTS models are offered?
      instructions:
      - text: Show the voice models agents can speak with.
      - text: Show available TTS models for voice output.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/scheduled_triggers_group/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure an agent's scheduled message group
      effect: write
      questions:
      - Can I cap how many scheduled messages an agent may have queued?
      - Is there a way to stop scheduled messages firing while a conversation is still active?
      instructions:
      - text: Set up the scheduled trigger group for agent {agent_id} with a max of {max_count}.
        slots:
          agent_id: path.agent_id
          max_count: requestBody.max_count
      - text: 'For agent {agent_id}, skip scheduled triggers while a conversation is active: {prevent_triggering_if_conversation_active}.'
        slots:
          agent_id: path.agent_id
          prevent_triggering_if_conversation_active: requestBody.prevent_triggering_if_conversation_active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/scheduled_triggers_item/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a future message for an agent
      effect: write
      questions:
      - How do I schedule a message to an agent to be sent a few minutes from now?
      - Can an agent send itself a follow-up message later in the same conversation?
      instructions:
      - text: Schedule message {message} to agent {agent_id} in conversation {conversation_id} in {minutes_until_schedule} minutes.
        slots:
          message: requestBody.message
          agent_id: path.agent_id
          conversation_id: requestBody.conversation_id
          minutes_until_schedule: requestBody.minutes_until_schedule
      - text: Queue a follow-up {message} for agent {agent_id}, conversation {conversation_id}, after {minutes_until_schedule} minutes.
        slots:
          message: requestBody.message
          agent_id: path.agent_id
          conversation_id: requestBody.conversation_id
          minutes_until_schedule: requestBody.minutes_until_schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/trigger/recurring/callback'].post
  update:
    x-apievangelist-phrasing:
      intent: Fire a recurring trigger
      effect: write
      questions:
      - How is a recurring sync trigger fired through its callback?
      - Can a recurring trigger be fired as a one-off with a custom message?
      instructions:
      - text: Fire recurring trigger {sync_id} for user {key_user_id} in project {project}.
        slots:
          sync_id: requestBody.sync_id
          key_user_id: requestBody.key_user_id
          project: requestBody.project
      - text: Run recurring trigger {sync_id} once with message {message} for user {key_user_id} in project {project}.
        slots:
          sync_id: requestBody.sync_id
          message: requestBody.message
          key_user_id: requestBody.key_user_id
          project: requestBody.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/scheduled_triggers_item/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scheduled agent message
      effect: destructive
      questions:
      - How do I cancel a message I scheduled for an agent before it sends?
      - Can I stop one scheduled agent message without touching the others?
      instructions:
      - text: Cancel scheduled message {trigger_id} for agent {agent_id}.
        slots:
          trigger_id: requestBody.trigger_id
          agent_id: path.agent_id
      - text: Stop the pending scheduled trigger {trigger_id} on agent {agent_id}.
        slots:
          trigger_id: requestBody.trigger_id
          agent_id: path.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/generate_requirements'].post
  update:
    x-apievangelist-phrasing:
      intent: Get auth account requirements for an agent's tools
      effect: read
      questions:
      - Which connected accounts does an agent's tools need before it can run?
      - What auth credentials are my agent's tools missing?
      instructions:
      - text: Show the auth account requirements for agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Check which tool accounts agent {agent_id} needs connected.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/aggregate_tagged_conversations'].post
  update:
    x-apievangelist-phrasing:
      intent: Aggregate tagged agent conversations
      effect: read
      questions:
      - Can I get counts of agent conversations grouped by their tags?
      - Is it possible to run an aggregation query over tagged conversations in a dataset?
      instructions:
      - text: Aggregate tagged agent conversations using {aggregation_query}.
        slots:
          aggregation_query: requestBody.aggregation_query
      - text: Summarize tagged conversations in dataset {dataset_id}.
        slots:
          dataset_id: requestBody.dataset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/list_custom_metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: List custom metadata fields used by agents
      effect: read
      questions:
      - What custom metadata fields are defined across my agents?
      - Can I see the custom metadata keys on one particular agent?
      instructions:
      - text: List all custom metadata fields across agents.
      - text: Show custom metadata fields for agent {agent_id}.
        slots:
          agent_id: requestBody.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/generate_params_schema'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a params schema from an agent's variables
      effect: read
      questions:
      - Can the platform work out an agent's input params schema from the variables it uses?
      - How do I get a full params schema generated for an agent definition?
      instructions:
      - text: Generate a params schema for agent definition {agent}.
        slots:
          agent: requestBody.agent
      - text: Detect variables in {agent} and output the full params schema.
        slots:
          agent: requestBody.agent
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/conversations/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent conversations
      effect: read
      questions:
      - How do I list all conversations my agents have had?
      - Can I mask PII when pulling back agent conversations?
      - Is it possible to search conversations by text and page through them?
      instructions:
      - text: List agent conversations, page {page}.
        slots:
          page: query.page
      - text: Search agent conversations for {query} with PII masked.
        slots:
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/tasks/match-groups/{hash}/conversations'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversations in a match group by hash (deprecated)
      effect: read
      questions:
      - Which conversations belong to a task match group hash on the older deprecated endpoint?
      - Can I still page through match group conversations by hash?
      instructions:
      - text: List conversations for match group hash {hash} using the deprecated endpoint.
        slots:
          hash: path.hash
      - text: Show page {page} of conversations in match group {hash}.
        slots:
          page: query.page
          hash: path.hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/tasks/match-group-conversations'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversations matching a task group selector
      effect: read
      questions:
      - What conversations match a task ops group selector?
      - Can I page through the conversations behind one grouped task view?
      instructions:
      - text: List conversations matching task group selector {selector}.
        slots:
          selector: query.selector
      - text: Show {page_size} conversations for group selector {selector}.
        slots:
          page_size: query.page_size
          selector: query.selector
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/tasks/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List grouped task views with counts
      effect: read
      questions:
      - How are my agent tasks grouped, and how many are in each group?
      - Can I group task ops by a field other than agent?
      instructions:
      - text: Show grouped task counts by agent.
      - text: Group agent tasks by {group_by} and show counts.
        slots:
          group_by: query.group_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/tasks/groups/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tasks inside one task group
      effect: read
      questions:
      - Which tasks sit inside a particular grouped task ops group?
      - Can I include eval details for the tasks in one group?
      instructions:
      - text: List the tasks in task group {group}.
        slots:
          group: query.group
      - text: Search tasks in group {group} for {query}.
        slots:
          group: query.group
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/conversations/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export agent conversations to CSV
      effect: read
      questions:
      - Can I download my agent conversations as a CSV file?
      - Is PII masking available when exporting conversations to a spreadsheet?
      instructions:
      - text: Export agent conversations to CSV.
      - text: Export conversations matching {query} to CSV with PII masked.
        slots:
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/conversations/latest_update_datetime'].get
  update:
    x-apievangelist-phrasing:
      intent: Get when an agent's conversations last changed
      effect: read
      questions:
      - When was the most recent conversation update for an agent?
      - Can I poll for the latest conversation change time to know if anything is new?
      instructions:
      - text: Get the latest conversation update time for agent {agent_id}.
        slots:
          agent_id: query.agent_id
      - text: Check when agent {agent_id} last had a conversation update.
        slots:
          agent_id: query.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/conversations/studios/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List tool runs within an agent conversation
      effect: read
      questions:
      - Which tools (studios) ran during a given agent conversation?
      - Can I page through the studio run history of one conversation?
      instructions:
      - text: List studio runs in conversation {conversation_id} of agent {agent_id}.
        slots:
          conversation_id: query.conversation_id
          agent_id: query.agent_id
      - text: Show the tool history for conversation {conversation_id}.
        slots:
          conversation_id: query.conversation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running agent
      effect: destructive
      questions:
      - How do I stop an agent that is currently running?
      - Can I cancel an in-progress agent job?
      instructions:
      - text: Cancel the running agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Stop agent {agent_id} now.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/submit-message-feedback'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit feedback on an agent message
      effect: write
      questions:
      - How do I give a thumbs up or down on a message an agent generated?
      - Can I leave feedback on a whole conversation rather than one message?
      instructions:
      - text: 'Mark message {message_id} in conversation {conversation_id} of agent {agent_id} as positive: {is_feedback_positive}, tags {task_tags}, details {task_details}.'
        slots:
          message_id: requestBody.message_id
          conversation_id: requestBody.conversation_id
          agent_id: path.agent_id
          is_feedback_positive: requestBody.is_feedback_positive
          task_tags: requestBody.task_tags
          task_details: requestBody.task_details
      - text: Add note {notes} as feedback on message {message_id} from agent {agent_id}.
        slots:
          notes: requestBody.notes
          message_id: requestBody.message_id
          agent_id: path.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/analytics'].post
  update:
    x-apievangelist-phrasing:
      intent: Get time-series analytics for agents
      effect: read
      questions:
      - What does agent usage look like over time?
      - Can I filter agent time-series analytics?
      instructions:
      - text: Show time-series analytics for my agents.
      - text: Get agent analytics filtered by {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/batch-schedule-agent-tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Page through an agent's batch-scheduled tasks
      effect: read
      questions:
      - Can I see the tasks inside a batch schedule I set up for an agent?
      - Which items are in an agent's batch-scheduled task group?
      instructions:
      - text: Show batch-scheduled tasks for agent {agent_id} in knowledge set {knowledge_set}, document {sync_document_id}.
        slots:
          agent_id: path.agent_id
          knowledge_set: requestBody.knowledge_set
          sync_document_id: requestBody.sync_document_id
      - text: Page through agent {agent_id}'s batch schedule {sync_document_id} in set {knowledge_set}.
        slots:
          agent_id: path.agent_id
          sync_document_id: requestBody.sync_document_id
          knowledge_set: requestBody.knowledge_set
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/batch-schedule-agent-tasks/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Batch-schedule tasks for an agent
      effect: write
      questions:
      - How do I schedule many tasks for one agent spread out over time?
      - Can I upload a CSV to fill a message template when batch-scheduling agent tasks?
      instructions:
      - text: Batch-schedule tasks for agent {agent_id} named {display_name} with template {message_template} and pacing {contract}.
        slots:
          agent_id: path.agent_id
          display_name: requestBody.display_name
          message_template: requestBody.message_template
          contract: requestBody.contract
      - text: Schedule agent {agent_id} tasks from CSV {csv} using template {message_template}, name {display_name}, pacing {contract}.
        slots:
          agent_id: path.agent_id
          csv: requestBody.csv
          message_template: requestBody.message_template
          display_name: requestBody.display_name
          contract: requestBody.contract
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/batch-schedule-agent-tasks/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an agent's batch-scheduled tasks
      effect: destructive
      questions:
      - How do I cancel a batch of scheduled tasks for an agent?
      - Does cancelling a batch schedule also cancel its individual items?
      instructions:
      - text: Cancel batch schedules {sync_document_ids} for agent {agent_id}.
        slots:
          sync_document_ids: requestBody.sync_document_ids
          agent_id: path.agent_id
      - text: Cancel all items in agent {agent_id}'s batch group {sync_document_ids}.
        slots:
          agent_id: path.agent_id
          sync_document_ids: requestBody.sync_document_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/batch-schedule-agent-tasks/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause an agent's batch-scheduled tasks
      effect: write
      questions:
      - Can I pause a batch of scheduled agent tasks and resume it later?
      - Is there a way to temporarily hold an agent's batch schedule?
      instructions:
      - text: Pause batch schedules {sync_document_ids} for agent {agent_id}.
        slots:
          sync_document_ids: requestBody.sync_document_ids
          agent_id: path.agent_id
      - text: Hold agent {agent_id}'s batch task group {sync_document_ids}.
        slots:
          agent_id: path.agent_id
          sync_document_ids: requestBody.sync_document_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}/batch-schedule-agent-tasks/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume an agent's paused batch-scheduled tasks
      effect: write
      questions:
      - How do I restart a paused batch of scheduled agent tasks?
      - Can a paused agent batch schedule pick up where it left off?
      instructions:
      - text: Resume batch schedules {sync_document_ids} for agent {agent_id}.
        slots:
          sync_document_ids: requestBody.sync_document_ids
          agent_id: path.agent_id
      - text: Unpause agent {agent_id}'s batch task group {sync_document_ids}.
        slots:
          agent_id: path.agent_id
          sync_document_ids: requestBody.sync_document_ids
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (117 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/overlays/relevance-ai-chat-api-phrasing-overlay.yaml