API Evangelist conversational phrasing for Relevance AI Endpoints Analytics 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 Analytics API
  version: 1.0.0
extends: openapi/relevance-ai-analytics-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: 23
- target: $.paths['/analytics/get_metrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a metric as a time series with summary stats
      effect: read
      questions:
      - How do I chart a single metric over time with summary statistics?
      - Can I group a metric's time series by a dimension?
      instructions:
      - text: Get metric {metric} from {start_date} to {end_date}.
        slots:
          metric: requestBody.metric
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show metric {metric} grouped by {group_by} between {start_date} and {end_date}.
        slots:
          metric: requestBody.metric
          group_by: requestBody.group_by
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/get_agent_breakdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Break down agents by tasks, errors and top actions
      effect: read
      questions:
      - Which agents had the highest error rates last week?
      - Can I see each agent's task count along with its most-used actions?
      instructions:
      - text: Show the agent breakdown with task counts, error rates and top actions from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Give me error rates and top actions for agents {agent_ids} since {start_date} until {end_date}.
        slots:
          agent_ids: requestBody.agent_ids
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/get_action_breakdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Break down actions by executions and credits
      effect: read
      questions:
      - Which actions ran the most and burned the most credits?
      - Can I see which agents use a given action most often?
      instructions:
      - text: Show the action breakdown with execution counts and credits from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Break down actions {action_ids} by executions and top agents between {start_date} and {end_date}.
        slots:
          action_ids: requestBody.action_ids
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/get_workforce_breakdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Break down workforces by tasks, errors and credits
      effect: read
      questions:
      - Which workforces are failing the most tasks?
      - Can I see top agents inside each workforce with its credit spend?
      instructions:
      - text: Show the workforce breakdown with task counts, error rates and top agents from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Give me error rates and top agents for workforces {workforce_ids} from {start_date} to {end_date}.
        slots:
          workforce_ids: requestBody.workforce_ids
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/get_agent_llm_usage_by_model'].post
  update:
    x-apievangelist-phrasing:
      intent: Break down agent usage by LLM model
      effect: read
      questions:
      - Which LLM models are my agents using, and how many tokens?
      - Can I compare input and output token counts per model for my agents?
      instructions:
      - text: Break down agent LLM usage by model, with credits and tokens, from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show tokens per model for agents {agent_ids} between {start_date} and {end_date}.
        slots:
          agent_ids: requestBody.agent_ids
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/get_agent_errors'].post
  update:
    x-apievangelist-phrasing:
      intent: List error messages from agents and tool runs
      effect: read
      questions:
      - What error messages did my agents hit yesterday?
      - Can I page through agent and tool run error messages with a cursor?
      instructions:
      - text: List agent and tool error messages from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show error messages for agents {agent_ids} between {start_date} and {end_date}.
        slots:
          agent_ids: requestBody.agent_ids
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/get_error_time_series'].get
  update:
    x-apievangelist-phrasing:
      intent: Get detailed error records with execution context
      effect: read
      questions:
      - Where can I find full execution context for each error, not just the message?
      - Can I filter detailed error records by workforce and source?
      instructions:
      - text: Get detailed error records with execution context for workforces {workforce_ids}.
        slots:
          workforce_ids: query.workforce_ids
      - text: Show the error time series from {start_date} to {end_date} filtered by source {source_filter}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          source_filter: query.source_filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/get_task_timeline'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart daily approval, escalated or errored tasks
      effect: read
      questions:
      - How many tasks were waiting for approval each day this month?
      - Can I chart escalated tasks per day for a set of agents?
      instructions:
      - text: Chart daily task counts for the {view} tab.
        slots:
          view: query.view
      - text: Show daily {view} task counts for agents {agent_ids} from {start_date} to {end_date}.
        slots:
          view: query.view
          agent_ids: query.agent_ids
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/analytics/concurrency_time_series'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart concurrency usage for an organization
      effect: read
      questions:
      - How close is my organization to its concurrency limit over time?
      - Can I break organization concurrency down by project?
      instructions:
      - text: Chart concurrency usage for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show concurrency for organization {organization_id} at {granularity} granularity, grouped by {group_by}.
        slots:
          organization_id: path.organization_id
          granularity: query.granularity
          group_by: query.group_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/analytics/live_jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List running and queued jobs for an organization
      effect: read
      questions:
      - What jobs are running or queued right now across my organization?
      - Can I list only the queued jobs in a given priority tier?
      instructions:
      - text: List live jobs for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show {state} jobs in priority tier {priority_tier} for organization {organization_id}.
        slots:
          state: query.state
          priority_tier: query.priority_tier
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/task_ops/tab_counts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get task counts for approvals, escalations and errors
      effect: read
      questions:
      - How many tasks are pending approval, escalated or errored right now?
      - Is there a single call for all the task tab counts?
      instructions:
      - text: Get the task tab counts for approvals, escalated, errors and all tasks.
      - text: Tell me how many tasks need approval right now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/get_usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage from agents and tool runs
      effect: read
      questions:
      - How much usage did my agents and tools generate over a time range?
      - Can I group usage data by a field and pick the metric?
      instructions:
      - text: Get usage for metric {metric} from {from} to {to}.
        slots:
          metric: query.metric
          from: query.from
          to: query.to
      - text: Show agent and tool run usage grouped by {group}.
        slots:
          group: query.group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/tool/breakdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Get per-tool usage totals
      effect: read
      questions:
      - Which tools ran the most and what did each cost in credits?
      - Can I see error rate and credits per run for each tool?
      instructions:
      - text: Show per-tool runs, credits and error rates from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Give totals for tools {tool_ids} between {start_date} and {end_date}.
        slots:
          tool_ids: requestBody.tool_ids
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/tool/breakdown/timeseries'].post
  update:
    x-apievangelist-phrasing:
      intent: Chart daily usage per tool
      effect: read
      questions:
      - Can I chart each tool's runs day by day as separate series?
      - How many tools are included in the per-tool daily chart data?
      instructions:
      - text: Chart daily usage for each tool separately from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Get per-tool per-day series for tools {tool_ids} from {start_date} to {end_date}.
        slots:
          tool_ids: requestBody.tool_ids
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/tool/timeseries'].post
  update:
    x-apievangelist-phrasing:
      intent: Chart combined daily tool usage
      effect: read
      questions:
      - What was my total tool usage per day, combined across tools?
      - Can I get one daily line of runs and credits for selected tools?
      instructions:
      - text: Chart combined daily tool runs and credits from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show one combined daily total for tools {tool_ids} between {start_date} and {end_date}.
        slots:
          tool_ids: requestBody.tool_ids
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/agent/breakdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Get per-agent usage totals
      effect: read
      questions:
      - Which agents ran the most tasks and spent the most credits over a period?
      - Can each agent's usage row include a rollup of the tools it called?
      instructions:
      - text: Show per-agent tasks, credits and error rates from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Give usage totals for agents {agent_ids} with per-tool children {children}, from {start_date} to {end_date}.
        slots:
          agent_ids: requestBody.agent_ids
          children: requestBody.children
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/agent/breakdown/timeseries'].post
  update:
    x-apievangelist-phrasing:
      intent: Chart daily usage per agent
      effect: read
      questions:
      - Can I chart every agent's tasks per day as its own series?
      - Is there a cap on how many agents appear in the per-agent daily series?
      instructions:
      - text: Chart daily usage for each agent separately from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Get per-agent per-day series for agents {agent_ids} from {start_date} to {end_date}.
        slots:
          agent_ids: requestBody.agent_ids
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/agent/timeseries'].post
  update:
    x-apievangelist-phrasing:
      intent: Chart combined daily agent usage
      effect: read
      questions:
      - What was my total agent activity per day, all agents combined?
      - Can I get daily agent tasks with model and tool credits split out?
      instructions:
      - text: Chart combined daily agent tasks and credits from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show one combined daily total for agents {agent_ids} between {start_date} and {end_date}.
        slots:
          agent_ids: requestBody.agent_ids
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/workforce/breakdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Get per-workforce usage totals
      effect: read
      questions:
      - Which workforces ran the most tasks and what did each cost?
      - How is error rate counted for workforce usage totals?
      instructions:
      - text: Show per-workforce tasks, credits and error rates from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Give usage totals for workforces {workforce_ids} with children {children}, from {start_date} to {end_date}.
        slots:
          workforce_ids: requestBody.workforce_ids
          children: requestBody.children
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/workforce/breakdown/timeseries'].post
  update:
    x-apievangelist-phrasing:
      intent: Chart daily usage per workforce
      effect: read
      questions:
      - Can I chart each workforce's tasks per day as separate lines?
      - How are per-workforce daily series limited by task volume?
      instructions:
      - text: Chart daily usage for each workforce separately from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Get per-workforce per-day series for workforces {workforce_ids} from {start_date} to {end_date}.
        slots:
          workforce_ids: requestBody.workforce_ids
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/workforce/timeseries'].post
  update:
    x-apievangelist-phrasing:
      intent: Chart combined daily workforce usage
      effect: read
      questions:
      - What was total workforce activity each day, all workforces combined?
      - Can I get daily workforce tasks with tool and model credits?
      instructions:
      - text: Chart combined daily workforce tasks and credits from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show one combined daily total for workforces {workforce_ids} between {start_date} and {end_date}.
        slots:
          workforce_ids: requestBody.workforce_ids
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/project/timeseries'].post
  update:
    x-apievangelist-phrasing:
      intent: Chart project-wide daily usage
      effect: read
      questions:
      - How much did my whole project use each day across agents, workforces and tools?
      - Can I see project credits split between tool execution and agent model calls?
      instructions:
      - text: Chart project-wide daily usage from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show my project's daily agent tasks, workforce tasks and tool runs since {start_date} through {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analytics/model/breakdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Break down AI model usage by where it was called
      effect: read
      questions:
      - Which AI models were called, and was it inside tools, agents or workforces?
      - Can I filter model usage to specific models and call contexts?
      instructions:
      - text: Break down AI model usage by model and context from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show usage of models {model_ids} in contexts {contexts} between {start_date} and {end_date}.
        slots:
          model_ids: requestBody.model_ids
          contexts: requestBody.contexts
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-09-26'