# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio - Taskrouter Workspaces API
  version: 1.0.0
extends: openapi/twilio-workspaces-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: 60
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Activities/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one worker activity state
      effect: read
      questions:
      - What are the details of a single TaskRouter activity like Offline or Break?
      - Can I check whether a specific activity makes agents available for tasks?
      instructions:
      - text: Show me activity {activity} in workspace {workspace}.
        slots:
          activity: path.Sid
          workspace: path.WorkspaceSid
      - text: Tell me whether activity {activity} in {workspace} counts as available.
        slots:
          activity: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Activities/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a worker activity
      effect: write
      questions:
      - Can I rename an existing TaskRouter activity without recreating it?
      - Is there a length limit on an activity's friendly name when I change it?
      instructions:
      - text: Rename activity {activity} in workspace {workspace} to {name}.
        slots:
          activity: path.Sid
          workspace: path.WorkspaceSid
          name: requestBody.FriendlyName
      - text: Change the label on existing activity {activity} in {workspace}.
        slots:
          activity: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Activities/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a worker activity
      effect: destructive
      questions:
      - How do I remove an activity state my agents no longer use?
      - What happens when I delete a TaskRouter activity from a workspace?
      instructions:
      - text: Delete activity {activity} from workspace {workspace}.
        slots:
          activity: path.Sid
          workspace: path.WorkspaceSid
      - text: Remove the unused activity state {activity} in {workspace}.
        slots:
          activity: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Activities'].get
  update:
    x-apievangelist-phrasing:
      intent: List the activity states in a workspace
      effect: read
      questions:
      - Which activity states are defined in my TaskRouter workspace?
      - Can I list only the activities that make workers available for tasks?
      instructions:
      - text: List every activity defined in workspace {workspace}.
        slots:
          workspace: path.WorkspaceSid
      - text: Show only activities in {workspace} where availability is {available}.
        slots:
          workspace: path.WorkspaceSid
          available: query.Available
      - text: Find the activity named {name} in workspace {workspace}.
        slots:
          name: query.FriendlyName
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Activities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new worker activity state
      effect: write
      questions:
      - How do I add a new agent status like Lunch to my TaskRouter workspace?
      - Can I make a new activity that keeps workers from receiving tasks?
      instructions:
      - text: Create an activity called {name} in workspace {workspace}.
        slots:
          name: requestBody.FriendlyName
          workspace: path.WorkspaceSid
      - text: Add activity {name} to {workspace} with available set to {available}.
        slots:
          name: requestBody.FriendlyName
          workspace: path.WorkspaceSid
          available: requestBody.Available
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Events/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single workspace event
      effect: read
      questions:
      - What exactly happened in one specific TaskRouter event?
      - Can I pull the full record of a single event by its ID?
      instructions:
      - text: Show me event {event} from workspace {workspace}.
        slots:
          event: path.Sid
          workspace: path.WorkspaceSid
      - text: Get the details of TaskRouter event {event} in {workspace}.
        slots:
          event: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Events'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse the event history of a workspace
      effect: read
      questions:
      - Where can I see the audit trail of what happened to tasks and workers in a workspace?
      - Can I filter workspace events to a single worker or a date range?
      - Which events did one task generate as it was routed?
      instructions:
      - text: List events in workspace {workspace} from the last {minutes} minutes.
        slots:
          workspace: path.WorkspaceSid
          minutes: query.Minutes
      - text: Show all events for task {task} in workspace {workspace}.
        slots:
          task: query.TaskSid
          workspace: path.WorkspaceSid
      - text: List {event_type} events in {workspace} between {start} and {end}.
        slots:
          event_type: query.EventType
          workspace: path.WorkspaceSid
          start: query.StartDate
          end: query.EndDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one routed task
      effect: read
      questions:
      - What is the current status and priority of a specific task in TaskRouter?
      - Can I see the attributes attached to a single task?
      instructions:
      - text: Show me task {task} in workspace {workspace}.
        slots:
          task: path.Sid
          workspace: path.WorkspaceSid
      - text: Check the assignment status of task {task} in {workspace}.
        slots:
          task: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change, cancel or complete a task
      effect: write
      questions:
      - How do I mark a TaskRouter task as completed with a reason?
      - Can I bump the priority of a task that is already waiting in a queue?
      - Is it possible to update a task only if nobody else changed it first?
      instructions:
      - text: Set task {task} in workspace {workspace} to {status} because {reason}.
        slots:
          task: path.Sid
          workspace: path.WorkspaceSid
          status: requestBody.AssignmentStatus
          reason: requestBody.Reason
      - text: Raise the priority of existing task {task} in {workspace} to {priority}.
        slots:
          task: path.Sid
          workspace: path.WorkspaceSid
          priority: requestBody.Priority
      - text: Replace the attributes of task {task} in {workspace} with {attributes}.
        slots:
          task: path.Sid
          workspace: path.WorkspaceSid
          attributes: requestBody.Attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a task
      effect: destructive
      questions:
      - How do I permanently remove a task from a TaskRouter workspace?
      - Can I guard a task deletion with an ETag so I don't delete a changed task?
      instructions:
      - text: Delete task {task} from workspace {workspace}.
        slots:
          task: path.Sid
          workspace: path.WorkspaceSid
      - text: Delete task {task} in {workspace} only if its ETag is still {etag}.
        slots:
          task: path.Sid
          workspace: path.WorkspaceSid
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tasks in a workspace
      effect: read
      questions:
      - Which tasks are still pending or reserved in my workspace right now?
      - Can I find tasks waiting in one particular queue?
      - Is there a way to list tasks whose attributes match an expression?
      instructions:
      - text: List tasks in workspace {workspace} with status {status}.
        slots:
          workspace: path.WorkspaceSid
          status: query.AssignmentStatus
      - text: Show the tasks waiting in queue {queue} in {workspace}.
        slots:
          queue: query.TaskQueueSid
          workspace: path.WorkspaceSid
      - text: Find tasks in {workspace} whose attributes match {expression}.
        slots:
          workspace: path.WorkspaceSid
          expression: query.EvaluateTaskAttributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task to be routed to a worker
      effect: write
      questions:
      - How do I send a new piece of work into TaskRouter to be routed to an agent?
      - Can I set a timeout so an unassigned task expires?
      - Which workflow routes a task when I create it?
      instructions:
      - text: Create a task in workspace {workspace} with attributes {attributes}.
        slots:
          workspace: path.WorkspaceSid
          attributes: requestBody.Attributes
      - text: Create a task in {workspace} routed by workflow {workflow} at priority {priority}.
        slots:
          workspace: path.WorkspaceSid
          workflow: requestBody.WorkflowSid
          priority: requestBody.Priority
      - text: Add a new task to {workspace} that expires after {timeout} seconds if unassigned.
        slots:
          workspace: path.WorkspaceSid
          timeout: requestBody.Timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one task channel
      effect: read
      questions:
      - What are the settings of a single task channel such as voice or chat?
      - Can I check whether a task channel prefers idle workers?
      instructions:
      - text: Show me task channel {channel} in workspace {workspace}.
        slots:
          channel: path.Sid
          workspace: path.WorkspaceSid
      - text: Get the configuration of task channel {channel} in {workspace}.
        slots:
          channel: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a task channel's name or idle routing
      effect: write
      questions:
      - Can I turn on idle-worker prioritization for an existing task channel?
      - How do I rename a task channel I already created?
      instructions:
      - text: Rename task channel {channel} in {workspace} to {name}.
        slots:
          channel: path.Sid
          workspace: path.WorkspaceSid
          name: requestBody.FriendlyName
      - text: Set channel-optimized routing to {optimized} on existing task channel {channel} in {workspace}.
        slots:
          optimized: requestBody.ChannelOptimizedRouting
          channel: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a task channel
      effect: destructive
      questions:
      - How do I get rid of a task channel we stopped using?
      - What do I need to delete a custom task channel from a workspace?
      instructions:
      - text: Delete task channel {channel} from workspace {workspace}.
        slots:
          channel: path.Sid
          workspace: path.WorkspaceSid
      - text: Remove the unused task channel {channel} in {workspace}.
        slots:
          channel: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskChannels'].get
  update:
    x-apievangelist-phrasing:
      intent: List the task channels in a workspace
      effect: read
      questions:
      - Which task channels like voice, SMS or chat exist in my workspace?
      - Can I see every channel type my TaskRouter workspace supports?
      instructions:
      - text: List all task channels in workspace {workspace}.
        slots:
          workspace: path.WorkspaceSid
      - text: Show me the channel types configured for {workspace}.
        slots:
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskChannels'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new task channel
      effect: write
      questions:
      - How do I add a new channel type such as video to TaskRouter?
      - Does a new task channel need both a friendly name and a unique name?
      instructions:
      - text: Create task channel {name} with unique name {unique_name} in workspace {workspace}.
        slots:
          name: requestBody.FriendlyName
          unique_name: requestBody.UniqueName
          workspace: path.WorkspaceSid
      - text: Add a {unique_name} channel to {workspace} labelled {name} that favours idle workers.
        slots:
          unique_name: requestBody.UniqueName
          workspace: path.WorkspaceSid
          name: requestBody.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one task queue
      effect: read
      questions:
      - What worker targeting rules does a specific task queue use?
      - Can I see the reservation and assignment activities set on one queue?
      instructions:
      - text: Show me task queue {queue} in workspace {workspace}.
        slots:
          queue: path.Sid
          workspace: path.WorkspaceSid
      - text: Get the target-workers expression for queue {queue} in {workspace}.
        slots:
          queue: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a task queue's targeting or ordering
      effect: write
      questions:
      - How do I change which workers an existing queue targets?
      - Can I switch a queue from first-in-first-out to last-in-first-out?
      - Is there a cap on how many workers a queue reserves per task, and can I change it?
      instructions:
      - text: Set the target workers on existing queue {queue} in {workspace} to {expression}.
        slots:
          queue: path.Sid
          workspace: path.WorkspaceSid
          expression: requestBody.TargetWorkers
      - text: Change task ordering on queue {queue} in {workspace} to {order}.
        slots:
          queue: path.Sid
          workspace: path.WorkspaceSid
          order: requestBody.TaskOrder
      - text: Let queue {queue} in {workspace} reserve up to {max} workers per task.
        slots:
          queue: path.Sid
          workspace: path.WorkspaceSid
          max: requestBody.MaxReservedWorkers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a task queue
      effect: destructive
      questions:
      - How do I retire a task queue we no longer route to?
      - What do I pass to delete a TaskRouter queue?
      instructions:
      - text: Delete task queue {queue} from workspace {workspace}.
        slots:
          queue: path.Sid
          workspace: path.WorkspaceSid
      - text: Remove the retired queue {queue} in {workspace}.
        slots:
          queue: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskQueues'].get
  update:
    x-apievangelist-phrasing:
      intent: List task queues in a workspace
      effect: read
      questions:
      - Which task queues are set up in my TaskRouter workspace?
      - Can I find the queues a particular worker is eligible for?
      instructions:
      - text: List the task queues in workspace {workspace}.
        slots:
          workspace: path.WorkspaceSid
      - text: Show which queues in {workspace} worker {worker} can serve.
        slots:
          workspace: path.WorkspaceSid
          worker: query.WorkerSid
      - text: Find the queue named {name} in {workspace}.
        slots:
          name: query.FriendlyName
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskQueues'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task queue
      effect: write
      questions:
      - How do I set up a new queue that only targets Spanish-speaking agents?
      - Can a new queue move workers into a specific activity when a task is assigned?
      instructions:
      - text: Create a task queue called {name} in workspace {workspace}.
        slots:
          name: requestBody.FriendlyName
          workspace: path.WorkspaceSid
      - text: Create queue {name} in {workspace} targeting workers that match {expression}.
        slots:
          name: requestBody.FriendlyName
          workspace: path.WorkspaceSid
          expression: requestBody.TargetWorkers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/CumulativeStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a queue's totals over a time window
      effect: read
      questions:
      - How many tasks did one queue handle, cancel or abandon over the past day?
      - Can I see a queue's wait-time totals split by thresholds like 30 and 60 seconds?
      instructions:
      - text: Get cumulative stats for queue {queue} in {workspace} over the last {minutes} minutes.
        slots:
          queue: path.TaskQueueSid
          workspace: path.WorkspaceSid
          minutes: query.Minutes
      - text: Show historic totals for queue {queue} in {workspace} split by wait times {thresholds}.
        slots:
          queue: path.TaskQueueSid
          workspace: path.WorkspaceSid
          thresholds: query.SplitByWaitTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/RealTimeStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: See what is happening in a queue right now
      effect: read
      questions:
      - How many tasks are waiting in a specific queue at this moment?
      - What is the longest current wait in one queue, live?
      instructions:
      - text: Show live stats for queue {queue} in workspace {workspace}.
        slots:
          queue: path.TaskQueueSid
          workspace: path.WorkspaceSid
      - text: Get the current backlog of queue {queue} in {workspace} for channel {channel}.
        slots:
          queue: path.TaskQueueSid
          workspace: path.WorkspaceSid
          channel: query.TaskChannel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/Statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a queue's combined live and historic stats
      effect: read
      questions:
      - Can I get both the live and cumulative numbers for one queue in a single call?
      - What does one queue's full statistics snapshot look like for a date range?
      instructions:
      - text: Get the combined real-time and cumulative stats for queue {queue} in {workspace}.
        slots:
          queue: path.TaskQueueSid
          workspace: path.WorkspaceSid
      - text: Show the full stats snapshot for queue {queue} in {workspace} from {start} to {end}.
        slots:
          queue: path.TaskQueueSid
          workspace: path.WorkspaceSid
          start: query.StartDate
          end: query.EndDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/TaskQueues/Statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare statistics across all queues
      effect: read
      questions:
      - Which of my queues is busiest compared with the others?
      - Can I pull statistics for every queue in a workspace at once?
      instructions:
      - text: List statistics for every task queue in workspace {workspace}.
        slots:
          workspace: path.WorkspaceSid
      - text: Compare all queues in {workspace} over the last {minutes} minutes.
        slots:
          workspace: path.WorkspaceSid
          minutes: query.Minutes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations'].get
  update:
    x-apievangelist-phrasing:
      intent: List the reservations made for a task
      effect: read
      questions:
      - Which workers has a particular task been offered to so far?
      - Can I see only the rejected or timed-out reservations for one task?
      instructions:
      - text: List reservations for task {task} in workspace {workspace}.
        slots:
          task: path.TaskSid
          workspace: path.WorkspaceSid
      - text: Show reservations of task {task} in {workspace} with status {status}.
        slots:
          task: path.TaskSid
          workspace: path.WorkspaceSid
          status: query.ReservationStatus
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one reservation on a task
      effect: read
      questions:
      - What is the status of a specific reservation offered for a task?
      - Can I look up one task reservation to see which worker it went to?
      instructions:
      - text: Show reservation {reservation} on task {task} in workspace {workspace}.
        slots:
          reservation: path.Sid
          task: path.TaskSid
          workspace: path.WorkspaceSid
      - text: Get the worker and status for task {task} reservation {reservation} in {workspace}.
        slots:
          task: path.TaskSid
          reservation: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept, reject or act on a task's reservation
      effect: write
      questions:
      - How do I accept or reject a reservation starting from the task side?
      - Can I dequeue a waiting call to an agent when accepting a task reservation?
      - Is it possible to connect the agent into a conference when handling a task's reservation?
      instructions:
      - text: Set reservation {reservation} on task {task} in {workspace} to {status}.
        slots:
          reservation: path.Sid
          task: path.TaskSid
          workspace: path.WorkspaceSid
          status: requestBody.ReservationStatus
      - text: Run the {instruction} instruction on task {task} reservation {reservation} in {workspace}.
        slots:
          instruction: requestBody.Instruction
          task: path.TaskSid
          reservation: path.Sid
          workspace: path.WorkspaceSid
      - text: Dequeue task {task}'s reservation {reservation} in {workspace} to agent contact {to}.
        slots:
          task: path.TaskSid
          reservation: path.Sid
          workspace: path.WorkspaceSid
          to: requestBody.DequeueTo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers'].get
  update:
    x-apievangelist-phrasing:
      intent: List the workers in a workspace
      effect: read
      questions:
      - Which agents are currently available in my TaskRouter workspace?
      - Can I find the workers who are eligible for one queue?
      - Is there a way to list workers in a given activity like Break?
      instructions:
      - text: List all workers in workspace {workspace}.
        slots:
          workspace: path.WorkspaceSid
      - text: Show workers in {workspace} currently in activity {activity}.
        slots:
          workspace: path.WorkspaceSid
          activity: query.ActivityName
      - text: Find workers in {workspace} eligible for queue {queue}.
        slots:
          workspace: path.WorkspaceSid
          queue: query.TaskQueueSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new worker (agent)
      effect: write
      questions:
      - How do I add a new agent to TaskRouter so they can receive tasks?
      - Can I give a new worker skills and languages as attributes when I create them?
      instructions:
      - text: Create a worker named {name} in workspace {workspace}.
        slots:
          name: requestBody.FriendlyName
          workspace: path.WorkspaceSid
      - text: Add new worker {name} to {workspace} with attributes {attributes}.
        slots:
          name: requestBody.FriendlyName
          workspace: path.WorkspaceSid
          attributes: requestBody.Attributes
      - text: Onboard worker {name} in {workspace} starting in activity {activity}.
        slots:
          name: requestBody.FriendlyName
          workspace: path.WorkspaceSid
          activity: requestBody.ActivitySid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one worker
      effect: read
      questions:
      - What activity is a specific agent in right now?
      - Can I see the skills and attributes recorded for one worker?
      instructions:
      - text: Show me worker {worker} in workspace {workspace}.
        slots:
          worker: path.Sid
          workspace: path.WorkspaceSid
      - text: Get the current activity and attributes of worker {worker} in {workspace}.
        slots:
          worker: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a worker's activity or attributes
      effect: write
      questions:
      - How do I put an agent on break or back online?
      - Can I reject an agent's pending reservations when I change their activity?
      - Is it possible to update a worker's skills without recreating them?
      instructions:
      - text: Move worker {worker} in {workspace} to activity {activity}.
        slots:
          worker: path.Sid
          workspace: path.WorkspaceSid
          activity: requestBody.ActivitySid
      - text: Replace the attributes of existing worker {worker} in {workspace} with {attributes}.
        slots:
          worker: path.Sid
          workspace: path.WorkspaceSid
          attributes: requestBody.Attributes
      - text: Set worker {worker} in {workspace} to {activity} and reject their pending reservations.
        slots:
          worker: path.Sid
          workspace: path.WorkspaceSid
          activity: requestBody.ActivitySid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a worker
      effect: destructive
      questions:
      - How do I offboard an agent who has left the team?
      - Can I make a worker deletion conditional on an ETag?
      instructions:
      - text: Delete worker {worker} from workspace {workspace}.
        slots:
          worker: path.Sid
          workspace: path.WorkspaceSid
      - text: Remove worker {worker} in {workspace} only if the ETag matches {etag}.
        slots:
          worker: path.Sid
          workspace: path.WorkspaceSid
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List a worker's per-channel capacity
      effect: read
      questions:
      - How many chats versus calls can one agent handle at the same time?
      - Which channels is a specific worker available on?
      instructions:
      - text: List the channels for worker {worker} in workspace {workspace}.
        slots:
          worker: path.WorkerSid
          workspace: path.WorkspaceSid
      - text: Show every channel capacity set for worker {worker} in {workspace}.
        slots:
          worker: path.WorkerSid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a worker's capacity on one channel
      effect: read
      questions:
      - What is one agent's capacity on a single channel like chat?
      - Can I check if a worker is available on one specific channel?
      instructions:
      - text: Show channel {channel} for worker {worker} in workspace {workspace}.
        slots:
          channel: path.Sid
          worker: path.WorkerSid
          workspace: path.WorkspaceSid
      - text: Get worker {worker}'s capacity on channel {channel} in {workspace}.
        slots:
          worker: path.WorkerSid
          channel: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a worker's capacity on a channel
      effect: write
      questions:
      - How do I let an agent handle three chats at once?
      - Can I turn off one channel for a worker without changing their activity?
      instructions:
      - text: Set worker {worker}'s capacity on channel {channel} in {workspace} to {capacity}.
        slots:
          worker: path.WorkerSid
          channel: path.Sid
          workspace: path.WorkspaceSid
          capacity: requestBody.Capacity
      - text: 'Make channel {channel} for worker {worker} in {workspace} available: {available}.'
        slots:
          channel: path.Sid
          worker: path.WorkerSid
          workspace: path.WorkspaceSid
          available: requestBody.Available
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics for one worker
      effect: read
      questions:
      - How much time did one agent spend in each activity today?
      - Can I see how many reservations a single worker accepted or rejected?
      instructions:
      - text: Show statistics for worker {worker} in workspace {workspace}.
        slots:
          worker: path.WorkerSid
          workspace: path.WorkspaceSid
      - text: Get worker {worker}'s stats in {workspace} over the last {minutes} minutes.
        slots:
          worker: path.WorkerSid
          workspace: path.WorkspaceSid
          minutes: query.Minutes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations'].get
  update:
    x-apievangelist-phrasing:
      intent: List the reservations offered to a worker
      effect: read
      questions:
      - Which tasks are currently offered to one agent?
      - Can I list only the pending reservations for a specific worker?
      instructions:
      - text: List reservations for worker {worker} in workspace {workspace}.
        slots:
          worker: path.WorkerSid
          workspace: path.WorkspaceSid
      - text: Show worker {worker}'s reservations in {workspace} with status {status}.
        slots:
          worker: path.WorkerSid
          workspace: path.WorkspaceSid
          status: query.ReservationStatus
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one reservation offered to a worker
      effect: read
      questions:
      - What task is behind a specific reservation an agent received?
      - Can I check one reservation from the worker's point of view?
      instructions:
      - text: Show reservation {reservation} for worker {worker} in workspace {workspace}.
        slots:
          reservation: path.Sid
          worker: path.WorkerSid
          workspace: path.WorkspaceSid
      - text: Get the status of worker {worker}'s reservation {reservation} in {workspace}.
        slots:
          worker: path.WorkerSid
          reservation: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept, reject or act on a worker's reservation
      effect: write
      questions:
      - How does an agent accept or reject a task offered to them?
      - Can I set the agent's next activity when they reject a reservation?
      - Is it possible to bridge the caller and agent into a recorded conference when the agent accepts?
      instructions:
      - text: Mark worker {worker}'s reservation {reservation} in {workspace} as {status}.
        slots:
          worker: path.WorkerSid
          reservation: path.Sid
          workspace: path.WorkspaceSid
          status: requestBody.ReservationStatus
      - text: Reject worker {worker}'s reservation {reservation} in {workspace} and move them to activity {activity}.
        slots:
          worker: path.WorkerSid
          reservation: path.Sid
          workspace: path.WorkspaceSid
          activity: requestBody.WorkerActivitySid
      - text: Execute {instruction} on the reservation {reservation} offered to worker {worker} in {workspace}.
        slots:
          instruction: requestBody.Instruction
          reservation: path.Sid
          worker: path.WorkerSid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers/Statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get combined statistics for all workers
      effect: read
      questions:
      - What does my whole team's activity breakdown look like right now and historically?
      - Can I get worker statistics limited to the agents who serve one queue?
      instructions:
      - text: Get combined worker statistics for workspace {workspace}.
        slots:
          workspace: path.WorkspaceSid
      - text: Show stats for workers serving queue {queue} in {workspace}.
        slots:
          queue: query.TaskQueueSid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get workforce totals over a time window
      effect: read
      questions:
      - How many reservations did my agents accept, reject or time out over the past hour?
      - Can I see total time spent in each activity across all workers for a date range?
      instructions:
      - text: Get cumulative worker totals for {workspace} over the last {minutes} minutes.
        slots:
          workspace: path.WorkspaceSid
          minutes: query.Minutes
      - text: Show historic workforce totals in {workspace} from {start} to {end}.
        slots:
          workspace: path.WorkspaceSid
          start: query.StartDate
          end: query.EndDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: See how many workers are in each activity now
      effect: read
      questions:
      - How many of my agents are available, busy or offline at this moment?
      - Can I get a live headcount of workers on just the voice channel?
      instructions:
      - text: Show the live worker headcount by activity in workspace {workspace}.
        slots:
          workspace: path.WorkspaceSid
      - text: Get real-time worker counts in {workspace} for channel {channel}.
        slots:
          workspace: path.WorkspaceSid
          channel: query.TaskChannel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one routing workflow
      effect: read
      questions:
      - What routing rules does a specific TaskRouter workflow apply?
      - Can I see the assignment callback URL a workflow uses?
      instructions:
      - text: Show me workflow {workflow} in workspace {workspace}.
        slots:
          workflow: path.Sid
          workspace: path.WorkspaceSid
      - text: Get the routing configuration of workflow {workflow} in {workspace}.
        slots:
          workflow: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a workflow's routing rules
      effect: write
      questions:
      - How do I change the routing rules of a workflow that is already live?
      - Can existing tasks be re-evaluated against a workflow's new rules?
      - What controls how long TaskRouter waits for my app to answer an assignment callback?
      instructions:
      - text: Replace the routing rules of workflow {workflow} in {workspace} with {configuration}.
        slots:
          workflow: path.Sid
          workspace: path.WorkspaceSid
          configuration: requestBody.Configuration
      - text: Point existing workflow {workflow} in {workspace} at assignment callback {url}.
        slots:
          workflow: path.Sid
          workspace: path.WorkspaceSid
          url: requestBody.AssignmentCallbackUrl
      - text: Set the reservation timeout on workflow {workflow} in {workspace} to {seconds} seconds.
        slots:
          workflow: path.Sid
          workspace: path.WorkspaceSid
          seconds: requestBody.TaskReservationTimeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a routing workflow
      effect: destructive
      questions:
      - How do I remove a workflow we replaced with a new one?
      - What is needed to delete a TaskRouter workflow?
      instructions:
      - text: Delete workflow {workflow} from workspace {workspace}.
        slots:
          workflow: path.Sid
          workspace: path.WorkspaceSid
      - text: Remove the retired routing workflow {workflow} in {workspace}.
        slots:
          workflow: path.Sid
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List routing workflows in a workspace
      effect: read
      questions:
      - Which routing workflows exist in my workspace?
      - Can I look up a workflow by its friendly name?
      instructions:
      - text: List the workflows in workspace {workspace}.
        slots:
          workspace: path.WorkspaceSid
      - text: Find the workflow named {name} in {workspace}.
        slots:
          name: query.FriendlyName
          workspace: path.WorkspaceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workflows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a routing workflow
      effect: write
      questions:
      - How do I define rules that route tasks to the right queue?
      - Is a JSON configuration required when creating a new workflow?
      instructions:
      - text: Create workflow {name} in {workspace} with routing rules {configuration}.
        slots:
          name: requestBody.FriendlyName
          workspace: path.WorkspaceSid
          configuration: requestBody.Configuration
      - text: Set up new workflow {name} in {workspace} using rules {configuration} and callback {url}.
        slots:
          name: requestBody.FriendlyName
          workspace: path.WorkspaceSid
          configuration: requestBody.Configuration
          url: requestBody.AssignmentCallbackUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/CumulativeStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow's totals over a time window
      effect: read
      questions:
      - How many tasks did one workflow route, cancel or time out over a period?
      - Can I break a workflow's historic wait times into buckets?
      instructions:
      - text: Get cumulative stats for workflow {workflow} in {workspace} over the last {minutes} minutes.
        slots:
          workflow: path.WorkflowSid
          workspace: path.WorkspaceSid
          minutes: query.Minutes
      - text: Show historic totals for workflow {workflow} in {workspace} split by wait times {thresholds}.
        slots:
          workflow: path.WorkflowSid
          workspace: path.WorkspaceSid
          thresholds: query.SplitByWaitTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/RealTimeStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: See a workflow's live task backlog
      effect: read
      questions:
      - How many tasks is one workflow handling at this moment?
      - What is the oldest task currently waiting in a workflow, live?
      instructions:
      - text: Show live stats for workflow {workflow} in workspace {workspace}.
        slots:
          workflow: path.WorkflowSid
          workspace: path.WorkspaceSid
      - text: Get workflow {workflow}'s current backlog in {workspace} for channel {channel}.
        slots:
          workflow: path.WorkflowSid
          workspace: path.WorkspaceSid
          channel: query.TaskChannel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/Statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow's combined live and historic stats
      effect: read
      questions:
      - Can I see both the live and cumulative numbers for one workflow together?
      - What does a workflow's full statistics snapshot show for a given date range?
      instructions:
      - text: Get combined real-time and cumulative stats for workflow {workflow} in {workspace}.
        slots:
          workflow: path.WorkflowSid
          workspace: path.WorkspaceSid
      - text: Show the full stats snapshot for workflow {workflow} in {workspace} from {start} to {end}.
        slots:
          workflow: path.WorkflowSid
          workspace: path.WorkspaceSid
          start: query.StartDate
          end: query.EndDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a TaskRouter workspace
      effect: read
      questions:
      - What are the default and timeout activities configured on my workspace?
      - Can I check whether multitasking is turned on for a workspace?
      instructions:
      - text: Show me workspace {workspace}.
        slots:
          workspace: path.Sid
      - text: Get the event callback URL and settings of workspace {workspace}.
        slots:
          workspace: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a workspace's settings
      effect: write
      questions:
      - How do I turn on multitasking for an existing TaskRouter workspace?
      - Can I limit which events a workspace sends to my callback URL?
      - Which activity do new workers start in, and can I change it?
      instructions:
      - text: 'Enable multitasking on workspace {workspace}: {enabled}.'
        slots:
          workspace: path.Sid
          enabled: requestBody.MultiTaskEnabled
      - text: Send events from existing workspace {workspace} to {url}.
        slots:
          workspace: path.Sid
          url: requestBody.EventCallbackUrl
      - text: Make {activity} the default activity for new workers in {workspace}.
        slots:
          activity: requestBody.DefaultActivitySid
          workspace: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a TaskRouter workspace
      effect: destructive
      questions:
      - How do I tear down a TaskRouter workspace I only used for testing?
      - What gets removed when I delete an entire workspace?
      instructions:
      - text: Delete workspace {workspace}.
        slots:
          workspace: path.Sid
      - text: Tear down the test workspace {workspace} entirely.
        slots:
          workspace: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List TaskRouter workspaces
      effect: read
      questions:
      - Which TaskRouter workspaces exist on my account?
      - Can I find a workspace by its friendly name?
      instructions:
      - text: List all my TaskRouter workspaces.
      - text: Find the workspace named {name}.
        slots:
          name: query.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a TaskRouter workspace
      effect: write
      questions:
      - How do I start a new contact-center routing setup in Twilio TaskRouter?
      - Can a new workspace come pre-built from the FIFO template?
      instructions:
      - text: Create a workspace called {name}.
        slots:
          name: requestBody.FriendlyName
      - text: Create workspace {name} from the {template} template with events sent to {url}.
        slots:
          name: requestBody.FriendlyName
          template: requestBody.Template
          url: requestBody.EventCallbackUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/CumulativeStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get workspace-wide totals over a time window
      effect: read
      questions:
      - How many tasks were created, completed or canceled across the whole workspace today?
      - Can I see workspace-wide wait-time buckets for a period?
      instructions:
      - text: Get cumulative workspace totals for {workspace} over the last {minutes} minutes.
        slots:
          workspace: path.WorkspaceSid
          minutes: query.Minutes
      - text: Show historic workspace-wide totals for {workspace} split by wait times {thresholds}.
        slots:
          workspace: path.WorkspaceSid
          thresholds: query.SplitByWaitTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/RealTimeStatistics'].get
  update:
    x-apievangelist-phrasing:
      intent: See live workspace-wide task and worker counts
      effect: read
      questions:
      - How many tasks are waiting across my entire contact center right now?
      - Can I get a live workspace snapshot for just the chat channel?
      instructions:
      - text: Show live workspace-wide stats for {workspace}.
        slots:
          workspace: path.WorkspaceSid
      - text: Get the current workspace backlog in {workspace} for channel {channel}.
        slots:
          workspace: path.WorkspaceSid
          channel: query.TaskChannel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Workspaces/{WorkspaceSid}/Statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get combined live and historic workspace stats
      effect: read
      questions:
      - Can I get both the real-time and cumulative workspace numbers in one response?
      - What does the overall workspace statistics report cover for a date range?
      instructions:
      - text: Get combined real-time and cumulative stats for workspace {workspace}.
        slots:
          workspace: path.WorkspaceSid
      - text: Show the overall workspace stats for {workspace} from {start} to {end}.
        slots:
          workspace: path.WorkspaceSid
          start: query.StartDate
          end: query.EndDate
      method: generated
      generated: '2026-09-26'