API Evangelist conversational phrasing for ElevenLabs API Documentation Convai API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ElevenLabs API Documentation Convai API
  version: 1.0.0
extends: openapi/elevenlabs-convai-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: 20
- target: $.paths['/v1/convai/agent-testing/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent response test
      effect: write
      questions:
      - How do I write a test that checks how my voice agent responds?
      - Can I save a reusable response test for my conversational agents?
      instructions:
      - text: Create a new agent response test.
      - text: Add a response test I can run against my agents later.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/agent-testing/{test_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent response test
      effect: read
      questions:
      - What does one of my saved agent response tests check for?
      - Can I look up a single agent test by its ID?
      instructions:
      - text: Get agent response test {test_id}.
        slots:
          test_id: path.test_id
      - text: Show me the definition of test {test_id}.
        slots:
          test_id: path.test_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/agent-testing/{test_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an agent response test
      effect: write
      questions:
      - Can I change the expected behavior in an existing agent response test?
      - Which call edits a response test I already created?
      instructions:
      - text: Update agent response test {test_id}.
        slots:
          test_id: path.test_id
      - text: Save my changes to the existing test {test_id}.
        slots:
          test_id: path.test_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/agent-testing/{test_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent response test
      effect: destructive
      questions:
      - How do I get rid of an agent response test I no longer need?
      - Can I delete a single agent test by ID?
      instructions:
      - text: Delete agent response test {test_id}.
        slots:
          test_id: path.test_id
      - text: Remove the obsolete test {test_id}.
        slots:
          test_id: path.test_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/agent-testing/summaries'].post
  update:
    x-apievangelist-phrasing:
      intent: Get summaries for several agent tests
      effect: read
      questions:
      - Can I fetch short summaries of several agent tests in one request?
      - What's a quick way to see names and types for a batch of test IDs?
      instructions:
      - text: Get summaries for agent tests {test_ids}.
        slots:
          test_ids: requestBody.test_ids
      - text: Summarize the response tests with IDs {test_ids}.
        slots:
          test_ids: requestBody.test_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/agent-testing'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent response tests
      effect: read
      questions:
      - Which agent response tests have I created so far?
      - Can I search my agent tests by name or browse them by folder?
      instructions:
      - text: List all my agent response tests.
      - text: Search my agent tests for {search}.
        slots:
          search: query.search
      - text: List the agent tests inside folder {parent_folder_id}.
        slots:
          parent_folder_id: query.parent_folder_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/test-invocations'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent test runs
      effect: read
      questions:
      - When were tests last run against my agent and how did they go?
      - Can I see the history of test invocations for one agent?
      instructions:
      - text: List test invocations for agent {agent_id}.
        slots:
          agent_id: query.agent_id
      - text: Show all recent test invocations across my agents.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/agents/{agent_id}/run-tests'].post
  update:
    x-apievangelist-phrasing:
      intent: Run tests against an agent
      effect: write
      questions:
      - How do I run my saved tests against a voice agent before shipping a change?
      - Can I test an agent with a config override without saving it?
      - Is it possible to repeat each test several times to check consistency?
      instructions:
      - text: Run tests {tests} on agent {agent_id}.
        slots:
          tests: requestBody.tests
          agent_id: path.agent_id
      - text: Run tests {tests} on agent {agent_id} branch {branch_id}, {repeat_count} times each.
        slots:
          tests: requestBody.tests
          agent_id: path.agent_id
          branch_id: requestBody.branch_id
          repeat_count: requestBody.repeat_count
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/test-invocations/{test_invocation_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of an agent test run
      effect: read
      questions:
      - Did my last agent test run pass?
      - Which individual tests failed in a given test invocation?
      instructions:
      - text: Get results of test invocation {test_invocation_id}.
        slots:
          test_invocation_id: path.test_invocation_id
      - text: Show which tests passed or failed in run {test_invocation_id}.
        slots:
          test_invocation_id: path.test_invocation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/test-invocations/{test_invocation_id}/resubmit'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-run selected tests from a test run
      effect: write
      questions:
      - Can I retry only the failed tests from an earlier run?
      - How do I re-run some test runs against a different agent branch?
      instructions:
      - text: Resubmit test runs {test_run_ids} from invocation {test_invocation_id} for agent {agent_id}.
        slots:
          test_run_ids: requestBody.test_run_ids
          test_invocation_id: path.test_invocation_id
          agent_id: requestBody.agent_id
      - text: Retry runs {test_run_ids} of invocation {test_invocation_id} on agent {agent_id} branch {branch_id}.
        slots:
          test_run_ids: requestBody.test_run_ids
          test_invocation_id: path.test_invocation_id
          agent_id: requestBody.agent_id
          branch_id: requestBody.branch_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/agents/{agent_id}/triage-tickets'].get
  update:
    x-apievangelist-phrasing:
      intent: List triage tickets for one agent
      effect: read
      questions:
      - What open quality tickets are there about one of my agents?
      - Can I filter an agent's triage tickets by assignee or issue type?
      instructions:
      - text: List triage tickets for agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Show agent {agent_id} tickets with status {status} assigned to {assignee_user_id}.
        slots:
          agent_id: path.agent_id
          status: query.status
          assignee_user_id: query.assignee_user_id
      - text: List tickets raised on conversation {conversation_id} for agent {agent_id}.
        slots:
          conversation_id: query.conversation_id
          agent_id: path.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/agents/{agent_id}/triage-tickets'].post
  update:
    x-apievangelist-phrasing:
      intent: Raise a follow-up ticket against an agent
      effect: write
      questions:
      - Can I log a to-do for an agent that isn't tied to any conversation?
      - How do I note that an agent needs a knowledge base update?
      instructions:
      - text: Raise a ticket on agent {agent_id} saying {qa_comment}.
        slots:
          agent_id: path.agent_id
          qa_comment: requestBody.qa_comment
      - text: 'Create a manual follow-up task for agent {agent_id}: {qa_comment}.'
        slots:
          agent_id: path.agent_id
          qa_comment: requestBody.qa_comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/triage-tickets'].get
  update:
    x-apievangelist-phrasing:
      intent: List triage tickets across the workspace
      effect: read
      questions:
      - What triage tickets are open across all agents in my workspace?
      - Can I see every ticket assigned to me regardless of agent?
      instructions:
      - text: List all workspace triage tickets with status {status}.
        slots:
          status: query.status
      - text: Show workspace-wide tickets assigned to {assignee_user_id}.
        slots:
          assignee_user_id: query.assignee_user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/triage-tickets'].post
  update:
    x-apievangelist-phrasing:
      intent: Flag an agent's performance on a conversation
      effect: write
      questions:
      - How do I report that my agent handled a specific call badly?
      - Can I comment on individual turns when flagging a conversation?
      instructions:
      - text: Open a ticket on conversation {conversation_id} with comment {qa_comment}.
        slots:
          conversation_id: requestBody.conversation_id
          qa_comment: requestBody.qa_comment
      - text: Flag conversation {conversation_id} for triage with turn comments {turn_comments}.
        slots:
          conversation_id: requestBody.conversation_id
          turn_comments: requestBody.turn_comments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/agents/{agent_id}/triage-tickets/assignable-users'].get
  update:
    x-apievangelist-phrasing:
      intent: List who can be assigned an agent's tickets
      effect: read
      questions:
      - Who in my workspace can I assign an agent's triage tickets to?
      - Which members lack viewer access to a given agent?
      instructions:
      - text: List assignable users for tickets on agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Show workspace members and whether they can view agent {agent_id}.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/triage-tickets/{agentqa_ticket_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a triage ticket
      effect: read
      questions:
      - What's the current status and comment on a particular triage ticket?
      - Can I open one agent ticket by its ID?
      instructions:
      - text: Get triage ticket {agentqa_ticket_id}.
        slots:
          agentqa_ticket_id: path.agentqa_ticket_id
      - text: Show me the details of ticket {agentqa_ticket_id}.
        slots:
          agentqa_ticket_id: path.agentqa_ticket_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/triage-tickets/{agentqa_ticket_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a triage ticket
      effect: destructive
      questions:
      - Who is allowed to delete an agent triage ticket?
      - How do I remove a ticket that was raised by mistake?
      instructions:
      - text: Delete triage ticket {agentqa_ticket_id}.
        slots:
          agentqa_ticket_id: path.agentqa_ticket_id
      - text: Remove the mistaken ticket {agentqa_ticket_id}.
        slots:
          agentqa_ticket_id: path.agentqa_ticket_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/triage-tickets/{agentqa_ticket_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a triage ticket's status or assignee
      effect: write
      questions:
      - Can I mark an agent ticket as resolved?
      - How do I reassign a triage ticket to a teammate?
      instructions:
      - text: Set ticket {agentqa_ticket_id} to status {status}.
        slots:
          agentqa_ticket_id: path.agentqa_ticket_id
          status: requestBody.status
      - text: Assign ticket {agentqa_ticket_id} to user {assignee_user_id}.
        slots:
          agentqa_ticket_id: path.agentqa_ticket_id
          assignee_user_id: requestBody.assignee_user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/triage-tickets/{agentqa_ticket_id}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a triage ticket
      effect: write
      questions:
      - Can I discuss how to fix an agent issue in the ticket thread?
      - What access do I need to comment on an agent's ticket?
      instructions:
      - text: Add comment {comment} to ticket {agentqa_ticket_id}.
        slots:
          comment: requestBody.comment
          agentqa_ticket_id: path.agentqa_ticket_id
      - text: Reply on ticket {agentqa_ticket_id} with {comment}.
        slots:
          agentqa_ticket_id: path.agentqa_ticket_id
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/convai/triage-tickets/{agentqa_ticket_id}/turn-comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a specific turn in a ticket
      effect: write
      questions:
      - Can I point at the exact conversation turn where the agent went wrong?
      - How do I attach a turn-level note to an existing ticket?
      instructions:
      - text: On ticket {agentqa_ticket_id}, comment {comment} on turn {turn_index}.
        slots:
          agentqa_ticket_id: path.agentqa_ticket_id
          comment: requestBody.comment
          turn_index: requestBody.turn_index
      - text: Add a note {comment} to turn {turn_index} of ticket {agentqa_ticket_id}.
        slots:
          comment: requestBody.comment
          turn_index: requestBody.turn_index
          agentqa_ticket_id: path.agentqa_ticket_id
      method: generated
      generated: '2026-09-26'