{ "openapi": "3.1.0", "info": { "title": "Cekura API", "version": "v1", "description": "Complete API documentation for the Cekura platform. This API provides endpoints for testing, observing, and evaluating AI voice agents — including managing agents, running evaluators, defining metrics, and analyzing call quality." }, "paths": { "/.well-known/oauth-authorization-server": { "get": { "operationId": ".well-known-oauth-authorization-server-retrieve", "tags": [ ".well-known" ], "responses": { "200": { "description": "No response body" } }, "description": ".well known oauth authorization server" } }, "/app/otel/validate/": { "get": { "operationId": "app-otel-validate-retrieve", "description": "Validate an API key owns the given agent or project.\n\nUsed by the OTel auth service. Returns 200 on success,\n401 on bad/missing key, 403 on ownership mismatch.\n\nQuery params: agent_id or project_id.", "tags": [ "app" ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v1/product-chat/": { "post": { "operationId": "app-v1-product-chat-create", "description": "Send a product-chat message and start the agent run (legacy v1).\n\nCreates the user/assistant messages, mints a stream token, kicks off\nthe run in the agent runtime, and returns `{progress_id}` where\n`progress_id` is the assistant message id.", "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v1/product-chat/cancel/": { "post": { "operationId": "app-v1-product-chat-cancel-create", "description": "Cancel an in-flight product-chat run (legacy v1).\n\nBody: `{progress_id}`. Flags the assistant message for cancel; the\nagent runtime picks up the flag on its next checkpoint.", "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v1/product-chat/commands/": { "get": { "operationId": "app-v1-product-chat-commands-retrieve", "description": "List slash commands available in the product-chat sandbox typeahead.", "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "{\"commands\": [{\"name\", \"description\", \"plugin\", \"command\"}, ...], \"cached_at\": \"\"}" }, "401": { "description": "Authentication required (Supabase JWT only)." } } } }, "/app/v1/product-chat/export-pdf/": { "post": { "operationId": "app-v1-product-chat-export-pdf-create", "description": "Export a product-chat assistant message as PDF (legacy v1).\n\nBody: `{session_id, message_index}`. Renders the assistant turn at\nthe given index via the shared PDF service and streams the result.", "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v1/product-chat/feedback/": { "post": { "operationId": "app-v1-product-chat-feedback-create", "description": "Record user feedback on a product-chat assistant message (legacy v1).\n\nBody: `{session_id, message_index?, rating, feedback?}`. Two\nside-effects, matching the legacy contract:\n 1. Persist the rating/text on `Message.metadata.feedback` for later UI.\n 2. Best-effort Slack alert via `send_product_chat_feedback_alert` so\n the team sees the report in real time. Slack failures don't fail\n the user request — same as the original `ProductChatFeedbackView`.", "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v1/product-chat/progress/": { "get": { "operationId": "app-v1-product-chat-progress-retrieve", "description": "Poll progress for an in-flight product-chat run (legacy v1).\n\nReturns the legacy `{status, chunks, session_id, ...}` shape. `chunks`\nis the delta of assistant content since the previous poll, computed\nvia a Redis cursor.", "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v1/product-chat/sessions/": { "get": { "operationId": "app-v1-product-chat-sessions-retrieve", "description": "List the user's product-chat sessions (legacy v1).\n\nReturns each non-deleted conversation as\n`{session_id, name, messages, updated_at}`, ordered by most-recent update.", "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v1/product-chat/sessions/{session_id}/": { "get": { "operationId": "app-v1-product-chat-sessions-retrieve_2", "description": "Read or delete a product-chat session (legacy v1).\n\nSoft-delete: sets `is_deleted=True` on the conversation. Accepts both\ncanonical UUIDs and legacy session ids.", "parameters": [ { "in": "path", "name": "session_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "app-v1-product-chat-sessions-destroy", "description": "Read or delete a product-chat session (legacy v1).\n\nSoft-delete: sets `is_deleted=True` on the conversation. Accepts both\ncanonical UUIDs and legacy session ids.", "parameters": [ { "in": "path", "name": "session_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/app/v2/product-chat/conversations/": { "get": { "operationId": "app-v2-product-chat-conversations-retrieve", "description": "List the user's product-chat conversations or create a new one.\n\n`GET` returns non-deleted conversations ordered by most-recent update.\n`POST` creates an empty conversation (optionally seeded with a name).", "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "app-v2-product-chat-conversations-create", "description": "List the user's product-chat conversations or create a new one.\n\n`GET` returns non-deleted conversations ordered by most-recent update.\n`POST` creates an empty conversation (optionally seeded with a name).", "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v2/product-chat/conversations/{conversation_id}/": { "get": { "operationId": "app-v2-product-chat-conversations-retrieve_2", "description": "Retrieve a product-chat conversation (with its messages) or soft-delete it.\n\n`GET` returns the conversation plus its ordered messages.\n`DELETE` soft-deletes it (sets `is_deleted=True`).", "parameters": [ { "in": "path", "name": "conversation_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "app-v2-product-chat-conversations-destroy", "description": "Retrieve a product-chat conversation (with its messages) or soft-delete it.\n\n`GET` returns the conversation plus its ordered messages.\n`DELETE` soft-deletes it (sets `is_deleted=True`).", "parameters": [ { "in": "path", "name": "conversation_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/app/v2/product-chat/conversations/{conversation_id}/messages/": { "post": { "operationId": "app-v2-product-chat-conversations-messages-create", "description": "Send a user message to a product-chat conversation and start the assistant run.\n\nCreates the user message + a streaming assistant message in one\ntransaction, mints a stream token, and returns the URL the browser\nshould open SSE against.", "parameters": [ { "in": "path", "name": "conversation_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v2/product-chat/conversations/{conversation_id}/status/": { "get": { "operationId": "app-v2-product-chat-conversations-status-retrieve", "description": "Return the current run state of the conversation's latest assistant turn: its status, partial or final content, and any error. Use this to recover the true state of an in-flight or finished turn when the live stream is interrupted — the tab was backgrounded, the page reloaded, or the connection dropped. `active_message` is null when the conversation has no assistant turns yet; clarification prompts are included only when the turn is waiting on the user.", "summary": "Get a conversation's live turn status", "parameters": [ { "in": "path", "name": "conversation_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationStatus" } } }, "description": "" } } } }, "/app/v2/product-chat/messages/{message_id}/cancel/": { "post": { "operationId": "app-v2-product-chat-messages-cancel-create", "description": "Cancel an in-flight product-chat assistant message.\n\nFlags the message for cancel; if no driver has attached yet, flips\nstatus synchronously so the message doesn't sit in `streaming` forever.", "parameters": [ { "in": "path", "name": "message_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v2/product-chat/messages/{message_id}/export-pdf/": { "post": { "operationId": "app-v2-product-chat-messages-export-pdf-create", "description": "Returns the rendered report PDF for a given message.\n\nLooks up the assistant `Message` by id, computes its index within the\nconversation (preserved for compatibility with legacy filename / template\nfields), and delegates to `render_message_as_pdf()`.", "parameters": [ { "in": "path", "name": "message_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v2/product-chat/messages/{message_id}/feedback/": { "post": { "operationId": "app-v2-product-chat-messages-feedback-create", "description": "Records feedback (thumbs up/down + optional text) on an assistant message.", "parameters": [ { "in": "path", "name": "message_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "app" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v2/product-chat/org-mcp-servers/": { "get": { "operationId": "app-v2-product-chat-org-mcp-servers-retrieve", "description": "List or create MCP servers for the authenticated user's org.", "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "app-v2-product-chat-org-mcp-servers-create", "description": "List or create MCP servers for the authenticated user's org.", "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v2/product-chat/org-mcp-servers/{server_id}/": { "get": { "operationId": "app-v2-product-chat-org-mcp-servers-retrieve_2", "description": "Retrieve an update, or delete a single MCP server by ID", "parameters": [ { "in": "path", "name": "server_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "app-v2-product-chat-org-mcp-servers-partial-update", "description": "Update an update, or delete a single MCP server", "parameters": [ { "in": "path", "name": "server_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "app-v2-product-chat-org-mcp-servers-destroy", "description": "Delete an update, or delete a single MCP server", "parameters": [ { "in": "path", "name": "server_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/app/v2/product-chat/org-skills/": { "get": { "operationId": "app-v2-product-chat-org-skills-retrieve", "description": "List all active custom skills for the org. Any member can read.", "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v2/product-chat/org-skills/{skill_id}/": { "get": { "operationId": "app-v2-product-chat-org-skills-retrieve_2", "description": "Retrieve a Read , toggle active/inactive or delete one skill by ID", "parameters": [ { "in": "path", "name": "skill_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "patch": { "operationId": "app-v2-product-chat-org-skills-partial-update", "description": "Update a Read , toggle active/inactive or delete one skill", "parameters": [ { "in": "path", "name": "skill_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "app-v2-product-chat-org-skills-destroy", "description": "Delete a Read , toggle active/inactive or delete one skill", "parameters": [ { "in": "path", "name": "skill_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/app/v2/product-chat/org-skills/sources/": { "get": { "operationId": "app-v2-product-chat-org-skills-sources-retrieve", "description": "List or create skill sources for the authenticated user's org.\n\nPOST accepts either:\n - multipart/form-data with source_type=zip and file=<.zip|.tar.gz>\n - application/json with source_type=github and github_url=", "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "app-v2-product-chat-org-skills-sources-create", "description": "List or create skill sources for the authenticated user's org.\n\nPOST accepts either:\n - multipart/form-data with source_type=zip and file=<.zip|.tar.gz>\n - application/json with source_type=github and github_url=", "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/app/v2/product-chat/org-skills/sources/{source_id}/": { "get": { "operationId": "app-v2-product-chat-org-skills-sources-retrieve_2", "description": "Retrieve a re-sync , or delete a skill source by ID", "parameters": [ { "in": "path", "name": "source_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "app-v2-product-chat-org-skills-sources-create_2", "description": "Re-sync a GitHub source (triggers a new Celery task).", "parameters": [ { "in": "path", "name": "source_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "app-v2-product-chat-org-skills-sources-destroy", "description": "Delete a re-sync , or delete a skill source", "parameters": [ { "in": "path", "name": "source_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/app/v2/product-chat/org-skills/sources/{source_id}/sync/": { "get": { "operationId": "app-v2-product-chat-org-skills-sources-sync-retrieve", "description": "App v2 product chat org skills sources sync", "parameters": [ { "in": "path", "name": "source_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "app-v2-product-chat-org-skills-sources-sync-create", "description": "Re-sync a GitHub source (triggers a new Celery task).", "parameters": [ { "in": "path", "name": "source_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "app-v2-product-chat-org-skills-sources-sync-destroy", "description": "App v2 product chat org skills sources sync", "parameters": [ { "in": "path", "name": "source_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/app/v2/product-chat/org-skills/upload/": { "post": { "operationId": "app-v2-product-chat-org-skills-upload-create", "description": "Upload a single .md file as a skill or command.\n\nAccepts multipart/form-data with a single \"file\" field.\nThe file is scanned immediately (synchronously) — fast because it's\na single file, no git clone or zip extraction required.", "tags": [ "app" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/dashboards/dashboards/": { "get": { "operationId": "dashboards-list", "description": "List dashboards accessible to the authenticated user. **Always pass `project_id`** — without it, all dashboards across every project in your organisation are returned, which can be a large result set.\n\n**Dashboard workflow:**\n1. `POST /dashboards/dashboards` — create a dashboard with a name, project, and date-range filters\n2. `POST /dashboards/widgets` — add widgets (line, bar, pie, or stat charts)\n3. `GET /dashboards/widgets/{id}/data` — fetch chart data (requires a timestamp filter)\n4. `POST /dashboards/dashboards/{id}/duplicate` — clone an existing dashboard as a starting point", "summary": "List dashboards", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "Filter by project ID. Strongly recommended — omitting returns all dashboards across every project." } ], "tags": [ "dashboards" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDashboardListList" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "dashboards-list", "description": "List dashboards accessible to the authenticated user. **Always pass `project_id`** — without it, all dashboards across every project in your organisation are returned, which can be a large result set.\n\n**Dashboard workflow:**\n1. `POST /dashboards/dashboards` — create a dashboard with a name, project, and date-range filters\n2. `POST /dashboards/widgets` — add widgets (line, bar, pie, or stat charts)\n3. `GET /dashboards/widgets/{id}/data` — fetch chart data (requires a timestamp filter)\n4. `POST /dashboards/dashboards/{id}/duplicate` — clone an existing dashboard as a starting point" } } }, "post": { "operationId": "dashboards-create", "description": "Manage analytics dashboards for visualizing agent performance.\n\nDashboards contain configurable widgets — line, bar, pie, or stat charts — that\ndisplay call volume, quality scores, metric trends, and other agent KPIs.\n\n**Dashboard filters** scope all widgets on the dashboard. Set a date range here\nso every widget automatically restricts to the same time window. Widget-level filters\nAND-combine with the dashboard filter.\n\n**Filter format** (`filters` field): a JSON condition object.\nSimple condition: `{\"field\": \"agent.id\", \"op\": \"eq\", \"value\": 123}`.\nCompound: `{\"operator\": \"and\", \"conditions\": [{\"field\": \"timestamp\", \"op\": \"gte\", \"value\": \"now-7d\"}, {\"field\": \"timestamp\", \"op\": \"lte\", \"value\": \"now\"}]}`.\nSupported fields: `id`, `success`, `duration`, `customer_number`, `call_ended_reason`,\n`dropoff_point`, `topic`, `timestamp`, `is_reviewed`, `agent.id`, `agent.agent_name`,\n`metadata.`, `metric_evaluations.value`.\nSupported operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `startswith`, `endswith`, `in`, `isnull`, `regex`.\n\nUse `duplicate` to clone an existing dashboard rather than building one from scratch.", "tags": [ "dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Dashboard" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Dashboard" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Create a dashboard", "x-mint": { "mcp": { "enabled": true, "name": "dashboards-create", "description": "Manage analytics dashboards for visualizing agent performance.\n\nDashboards contain configurable widgets — line, bar, pie, or stat charts — that\ndisplay call volume, quality scores, metric trends, and other agent KPIs.\n\n**Dashboard filters** scope all widgets on the dashboard. Set a date range here\nso every widget automatically restricts to the same time window. Widget-level filters\nAND-combine with the dashboard filter.\n\n**Filter format** (`filters` field): a JSON condition object.\nSimple condition: `{\"field\": \"agent.id\", \"op\": \"eq\", \"value\": 123}`.\nCompound: `{\"operator\": \"and\", \"conditions\": [{\"field\": \"timestamp\", \"op\": \"gte\", \"value\": \"now-7d\"}, {\"field\": \"timestamp\", \"op\": \"lte\", \"value\": \"now\"}]}`.\nSupported fields: `id`, `success`, `duration`, `customer_number`, `call_ended_reason`,\n`dropoff_point`, `topic`, `timestamp`, `is_reviewed`, `agent.id`, `agent.agent_name`,\n`metadata.`, `metric_evaluations.value`.\nSupported operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `startswith`, `endswith`, `in`, `isnull`, `regex`.\n\nUse `duplicate` to clone an existing dashboard rather than building one from scratch." } } } }, "/dashboards/dashboards/{id}/": { "get": { "operationId": "dashboards-retrieve", "description": "Manage analytics dashboards for visualizing agent performance.\n\nDashboards contain configurable widgets — line, bar, pie, or stat charts — that\ndisplay call volume, quality scores, metric trends, and other agent KPIs.\n\n**Dashboard filters** scope all widgets on the dashboard. Set a date range here\nso every widget automatically restricts to the same time window. Widget-level filters\nAND-combine with the dashboard filter.\n\n**Filter format** (`filters` field): a JSON condition object.\nSimple condition: `{\"field\": \"agent.id\", \"op\": \"eq\", \"value\": 123}`.\nCompound: `{\"operator\": \"and\", \"conditions\": [{\"field\": \"timestamp\", \"op\": \"gte\", \"value\": \"now-7d\"}, {\"field\": \"timestamp\", \"op\": \"lte\", \"value\": \"now\"}]}`.\nSupported fields: `id`, `success`, `duration`, `customer_number`, `call_ended_reason`,\n`dropoff_point`, `topic`, `timestamp`, `is_reviewed`, `agent.id`, `agent.agent_name`,\n`metadata.`, `metric_evaluations.value`.\nSupported operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `startswith`, `endswith`, `in`, `isnull`, `regex`.\n\nUse `duplicate` to clone an existing dashboard rather than building one from scratch.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "dashboards" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Get a dashboard", "x-mint": { "mcp": { "enabled": true, "name": "dashboards-retrieve", "description": "Manage analytics dashboards for visualizing agent performance.\n\nDashboards contain configurable widgets — line, bar, pie, or stat charts — that\ndisplay call volume, quality scores, metric trends, and other agent KPIs.\n\n**Dashboard filters** scope all widgets on the dashboard. Set a date range here\nso every widget automatically restricts to the same time window. Widget-level filters\nAND-combine with the dashboard filter.\n\n**Filter format** (`filters` field): a JSON condition object.\nSimple condition: `{\"field\": \"agent.id\", \"op\": \"eq\", \"value\": 123}`.\nCompound: `{\"operator\": \"and\", \"conditions\": [{\"field\": \"timestamp\", \"op\": \"gte\", \"value\": \"now-7d\"}, {\"field\": \"timestamp\", \"op\": \"lte\", \"value\": \"now\"}]}`.\nSupported fields: `id`, `success`, `duration`, `customer_number`, `call_ended_reason`,\n`dropoff_point`, `topic`, `timestamp`, `is_reviewed`, `agent.id`, `agent.agent_name`,\n`metadata.`, `metric_evaluations.value`.\nSupported operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `startswith`, `endswith`, `in`, `isnull`, `regex`.\n\nUse `duplicate` to clone an existing dashboard rather than building one from scratch." } } }, "put": { "operationId": "dashboards-update", "description": "Manage analytics dashboards for visualizing agent performance.\n\nDashboards contain configurable widgets — line, bar, pie, or stat charts — that\ndisplay call volume, quality scores, metric trends, and other agent KPIs.\n\n**Dashboard filters** scope all widgets on the dashboard. Set a date range here\nso every widget automatically restricts to the same time window. Widget-level filters\nAND-combine with the dashboard filter.\n\n**Filter format** (`filters` field): a JSON condition object.\nSimple condition: `{\"field\": \"agent.id\", \"op\": \"eq\", \"value\": 123}`.\nCompound: `{\"operator\": \"and\", \"conditions\": [{\"field\": \"timestamp\", \"op\": \"gte\", \"value\": \"now-7d\"}, {\"field\": \"timestamp\", \"op\": \"lte\", \"value\": \"now\"}]}`.\nSupported fields: `id`, `success`, `duration`, `customer_number`, `call_ended_reason`,\n`dropoff_point`, `topic`, `timestamp`, `is_reviewed`, `agent.id`, `agent.agent_name`,\n`metadata.`, `metric_evaluations.value`.\nSupported operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `startswith`, `endswith`, `in`, `isnull`, `regex`.\n\nUse `duplicate` to clone an existing dashboard rather than building one from scratch.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Dashboard" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Dashboard" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } } }, "patch": { "operationId": "dashboards-partial-update", "description": "Manage analytics dashboards for visualizing agent performance.\n\nDashboards contain configurable widgets — line, bar, pie, or stat charts — that\ndisplay call volume, quality scores, metric trends, and other agent KPIs.\n\n**Dashboard filters** scope all widgets on the dashboard. Set a date range here\nso every widget automatically restricts to the same time window. Widget-level filters\nAND-combine with the dashboard filter.\n\n**Filter format** (`filters` field): a JSON condition object.\nSimple condition: `{\"field\": \"agent.id\", \"op\": \"eq\", \"value\": 123}`.\nCompound: `{\"operator\": \"and\", \"conditions\": [{\"field\": \"timestamp\", \"op\": \"gte\", \"value\": \"now-7d\"}, {\"field\": \"timestamp\", \"op\": \"lte\", \"value\": \"now\"}]}`.\nSupported fields: `id`, `success`, `duration`, `customer_number`, `call_ended_reason`,\n`dropoff_point`, `topic`, `timestamp`, `is_reviewed`, `agent.id`, `agent.agent_name`,\n`metadata.`, `metric_evaluations.value`.\nSupported operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `startswith`, `endswith`, `in`, `isnull`, `regex`.\n\nUse `duplicate` to clone an existing dashboard rather than building one from scratch.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDashboard" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDashboard" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDashboard" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Update a dashboard", "x-mint": { "mcp": { "enabled": true, "name": "dashboards-partial-update", "description": "Manage analytics dashboards for visualizing agent performance.\n\nDashboards contain configurable widgets — line, bar, pie, or stat charts — that\ndisplay call volume, quality scores, metric trends, and other agent KPIs.\n\n**Dashboard filters** scope all widgets on the dashboard. Set a date range here\nso every widget automatically restricts to the same time window. Widget-level filters\nAND-combine with the dashboard filter.\n\n**Filter format** (`filters` field): a JSON condition object.\nSimple condition: `{\"field\": \"agent.id\", \"op\": \"eq\", \"value\": 123}`.\nCompound: `{\"operator\": \"and\", \"conditions\": [{\"field\": \"timestamp\", \"op\": \"gte\", \"value\": \"now-7d\"}, {\"field\": \"timestamp\", \"op\": \"lte\", \"value\": \"now\"}]}`.\nSupported fields: `id`, `success`, `duration`, `customer_number`, `call_ended_reason`,\n`dropoff_point`, `topic`, `timestamp`, `is_reviewed`, `agent.id`, `agent.agent_name`,\n`metadata.`, `metric_evaluations.value`.\nSupported operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `startswith`, `endswith`, `in`, `isnull`, `regex`.\n\nUse `duplicate` to clone an existing dashboard rather than building one from scratch." } } }, "delete": { "operationId": "dashboards-destroy", "description": "⚠ Irreversible. Deletes the dashboard and all of its widgets.", "summary": "Delete a dashboard", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "dashboards" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "404": { "description": "No response body" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "dashboards-destroy", "description": "⚠ Irreversible. Deletes the dashboard and all of its widgets." } } } }, "/dashboards/dashboards/{id}/bulk_widgets/": { "post": { "operationId": "dashboards-bulk-widgets", "description": "Bulk create, update, and delete widgets for a dashboard.\n\nAll operations are performed in a single transaction.\n\nRequest body:\n{\n \"create\": [{\"name\": \"Widget 1\", \"field\": \"duration\", \"chart_type\": \"line\"}, ...],\n \"update\": [{\"id\": 1, \"name\": \"Updated Name\"}, ...],\n \"delete\": [2, 3, 4]\n}\n\nReturns:\n{\n \"created\": [...], # List of created widgets\n \"updated\": [...], # List of updated widgets\n \"deleted\": [...] # List of deleted widget IDs\n}", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkWidgetOperationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BulkWidgetOperationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BulkWidgetOperationRequest" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkWidgetOperationResponse" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Bulk edit dashboard widgets", "x-mint": { "mcp": { "enabled": true, "name": "dashboards-bulk-widgets", "description": "Bulk create, update, and delete widgets for a dashboard.\n\nAll operations are performed in a single transaction.\n\nRequest body:\n{\n \"create\": [{\"name\": \"Widget 1\", \"field\": \"duration\", \"chart_type\": \"line\"}, ...],\n \"update\": [{\"id\": 1, \"name\": \"Updated Name\"}, ...],\n \"delete\": [2, 3, 4]\n}\n\nReturns:\n{\n \"created\": [...], # List of created widgets\n \"updated\": [...], # List of updated widgets\n \"deleted\": [...] # List of deleted widget IDs\n}" } } } }, "/dashboards/dashboards/{id}/duplicate/": { "post": { "operationId": "dashboards-duplicate", "description": "Duplicate a dashboard and all its widgets.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DuplicateDashboardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DuplicateDashboardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DuplicateDashboardRequest" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Duplicate a dashboard", "x-mint": { "mcp": { "enabled": true, "name": "dashboards-duplicate", "description": "Duplicate a dashboard and all its widgets." } } } }, "/dashboards/dashboards/predefined_widgets/": { "get": { "operationId": "dashboards-predefined-widgets", "description": "Return a list of predefined widget configurations for quick-add.\nResolves project-specific details like metric IDs for latency.", "tags": [ "dashboards" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } }, "description": "" } } } }, "/dashboards/widgets/": { "get": { "operationId": "dashboards-widgets-list", "description": "List dashboard widgets", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "dashboard_id", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `dashboard_id` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ], "tags": [ "dashboards" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWidgetList" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "List dashboard widgets", "x-mint": { "mcp": { "enabled": true, "name": "dashboards-widgets-list", "description": "List dashboard widgets" } } }, "post": { "operationId": "dashboards-widgets-create", "description": "Create a dashboard widget", "tags": [ "dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Widget" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Widget" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Create a dashboard widget", "x-mint": { "mcp": { "enabled": true, "name": "dashboards-widgets-create", "description": "Create a dashboard widget" } } } }, "/dashboards/widgets/{id}/": { "get": { "operationId": "dashboards-widgets-retrieve", "description": "Get a dashboard widget", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "dashboards" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Get a dashboard widget", "x-mint": { "mcp": { "enabled": true, "name": "dashboards-widgets-retrieve", "description": "Get a dashboard widget" } } }, "put": { "operationId": "dashboards-widgets-update", "description": "Update a dashboard widget", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Widget" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Widget" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } } }, "description": "" } } }, "patch": { "operationId": "dashboards-widgets-partial-update", "description": "Update a dashboard widget", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedWidget" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedWidget" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedWidget" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Update a dashboard widget", "x-mint": { "mcp": { "enabled": true, "name": "dashboards-widgets-partial-update", "description": "Update a dashboard widget" } } }, "delete": { "operationId": "dashboards-widgets-destroy", "description": "⚠ Irreversible. Deletes this widget from its dashboard.", "summary": "Delete a widget", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "dashboards" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "404": { "description": "No response body" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "dashboards-widgets-destroy", "description": "⚠ Irreversible. Deletes this widget from its dashboard." } } } }, "/dashboards/widgets/{id}/data/": { "get": { "operationId": "dashboards-widgets-data-retrieve", "description": "Fetch the computed chart data for a saved widget.\n\n**Timestamp filter required:** a `gt` or `gte` filter on `timestamp` must be present — either set on the dashboard, the widget, or passed here as `filters`. Maximum range: 30 days. Without it the request returns a 400 error.\n\n**Override filters:** pass `filters` as a filter JSON object to temporarily replace the widget's own filters for this request. Example: `{\"operator\": \"and\", \"conditions\": [{\"field\": \"timestamp\", \"op\": \"gte\", \"value\": \"now-7d\"}, {\"field\": \"timestamp\", \"op\": \"lte\", \"value\": \"now\"}]}`\n\n**Response shape by chart type:**\n- `line` — `{data: [{id, timestamp, value}], metadata: {display_name, data_type, filter_value}}`\n- `bar` — `{data: [{time_interval, value, sample_count}], metadata: ...}`\n- `pie` — `{data: [{label, value, percentage}], metadata: ...}`\n- `stat` — `{data: {total_calls, success_rate, avg_duration, p95_latency}, metadata: ...}`", "summary": "Get widget chart data", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "filters", "schema": { "type": "object" }, "description": "filter JSON object to override widget filters for this request. Must include a timestamp constraint. Example: `{\"operator\": \"and\", \"conditions\": [{\"field\": \"timestamp\", \"op\": \"gte\", \"value\": \"now-7d\"}]}`" } ], "tags": [ "dashboards" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetDataResponse" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "dashboards-widgets-data-retrieve", "description": "Fetch the computed chart data for a saved widget.\n\n**Timestamp filter required:** a `gt` or `gte` filter on `timestamp` must be present — either set on the dashboard, the widget, or passed here as `filters`. Maximum range: 30 days. Without it the request returns a 400 error.\n\n**Override filters:** pass `filters` as a filter JSON object to temporarily replace the widget's own filters for this request. Example: `{\"operator\": \"and\", \"conditions\": [{\"field\": \"timestamp\", \"op\": \"gte\", \"value\": \"now-7d\"}, {\"field\": \"timestamp\", \"op\": \"lte\", \"value\": \"now\"}]}`\n\n**Response shape by chart type:**\n- `line` — `{data: [{id, timestamp, value}], metadata: {display_name, data_type, filter_value}}`\n- `bar` — `{data: [{time_interval, value, sample_count}], metadata: ...}`\n- `pie` — `{data: [{label, value, percentage}], metadata: ...}`\n- `stat` — `{data: {total_calls, success_rate, avg_duration, p95_latency}, metadata: ...}`" } } } }, "/dashboards/widgets/bulk_data/": { "post": { "operationId": "dashboards-widgets-bulk-data-create", "description": "Get plot data for multiple widgets at once.\n\nAccepts a list of widget IDs and optional override filters.\nReturns data for all specified widgets.\nFilter format follows filter JSON structure.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkWidgetDataRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BulkWidgetDataRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BulkWidgetDataRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWidgetDataResponseList" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Get data for multiple widgets", "x-mint": { "mcp": { "enabled": true, "name": "dashboards-widgets-bulk-data-create", "description": "Get plot data for multiple widgets at once.\n\nAccepts a list of widget IDs and optional override filters.\nReturns data for all specified widgets.\nFilter format follows filter JSON structure." } } } }, "/dashboards/widgets/preview_data/": { "post": { "operationId": "dashboards-widgets-preview-data-create", "description": "Preview widget data without saving.", "tags": [ "dashboards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Widget" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Widget" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "shareable_link": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetDataResponse" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Preview widget data", "x-mint": { "mcp": { "enabled": true, "name": "dashboards-widgets-preview-data-create", "description": "Preview widget data without saving." } } } }, "/discord/servers/": { "get": { "operationId": "discord-servers-list", "tags": [ "discord" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiscordServer" } } } }, "description": "" } }, "description": "List discord servers" }, "post": { "operationId": "discord-servers-create", "tags": [ "discord" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscordServer" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DiscordServer" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DiscordServer" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscordServer" } } }, "description": "" } }, "description": "Create a new discord server" } }, "/discord/servers/{id}/": { "get": { "operationId": "discord-servers-retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this discord server.", "required": true } ], "tags": [ "discord" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscordServer" } } }, "description": "" } }, "description": "Retrieve a discord server by ID" }, "put": { "operationId": "discord-servers-update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this discord server.", "required": true } ], "tags": [ "discord" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscordServer" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DiscordServer" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DiscordServer" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscordServer" } } }, "description": "" } }, "description": "Update a discord server" }, "patch": { "operationId": "discord-servers-partial-update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this discord server.", "required": true } ], "tags": [ "discord" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDiscordServer" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDiscordServer" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDiscordServer" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscordServer" } } }, "description": "" } }, "description": "Update a discord server" }, "delete": { "operationId": "discord-servers-destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this discord server.", "required": true } ], "tags": [ "discord" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "204": { "description": "No response body" } }, "description": "Delete a discord server" } }, "/discord/servers/{id}/verify/": { "get": { "operationId": "discord-servers-verify-retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this discord server.", "required": true } ], "tags": [ "discord" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscordServer" } } }, "description": "" } }, "description": "Discord servers verify" } }, "/enums/": { "get": { "operationId": "enums-retrieve", "tags": [ "enums" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } }, "description": "Enums" } }, "/github/checkout-token/": { "post": { "operationId": "github-checkout-token-create", "description": "Create a short-lived, read-only checkout credential for one repository. Requires an authenticated Cekura agent session, and the repository must be available through the organization's active GitHub connection. Repository access is verified for every request.", "summary": "Authorize a connected repository checkout", "tags": [ "github" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutTokenRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CheckoutTokenRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CheckoutTokenRequest" } } }, "required": true }, "security": [ { "product_chat_sandbox": [] } ], "responses": { "200": { "description": "Repository checkout details and a short-lived credential." }, "401": { "description": "Authentication required." }, "404": { "description": "The repository is not available through the active connection." } } } }, "/github/connection/": { "get": { "operationId": "github-connection-retrieve", "description": "GET connection status for the org; DELETE to disconnect (mark inactive).", "tags": [ "github" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } }, "delete": { "operationId": "github-connection-destroy", "description": "GET connection status for the org; DELETE to disconnect (mark inactive).", "tags": [ "github" ], "security": [ { "supabase_session": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/github/install-url/": { "get": { "operationId": "github-install-url-retrieve", "description": "Return the GitHub App install URL with a single-use signed state.", "tags": [ "github" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/github/open-pr/": { "post": { "operationId": "github-open-pr-create", "description": "Create a new branch and open a pull request containing the submitted file changes. Requires an authenticated Cekura agent session, and the repository must be available through the organization's active GitHub connection. Direct writes to the default branch are not permitted, and repository access is verified for every request.", "summary": "Open a pull request in a connected repository", "tags": [ "github" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenPRRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OpenPRRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OpenPRRequest" } } }, "required": true }, "security": [ { "product_chat_sandbox": [] } ], "responses": { "201": { "description": "Pull request created on a new branch." }, "400": { "description": "The pull request could not be created." }, "401": { "description": "Authentication required." }, "404": { "description": "The repository is not available through the active connection." } } } }, "/github/setup/": { "post": { "operationId": "github-setup-create", "description": "Verify the installer with GitHub, then connect the installation.", "tags": [ "github" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/github/webhook/": { "post": { "operationId": "github-webhook-create", "description": "GitHub App webhook. No auth class — the HMAC signature is the gate.", "tags": [ "github" ], "responses": { "200": { "description": "No response body" } } } }, "/notifications/v1/notifications/": { "get": { "operationId": "notifications-v1-notifications-list", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "notifications" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationList" } } }, "description": "" } }, "description": "List notifications v1 notifications" } }, "/notifications/v1/notifications/{id}/": { "get": { "operationId": "notifications-v1-notifications-retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "notifications" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "" } }, "description": "Retrieve a notifications v1 notification by ID" } }, "/notifications/v1/notifications/{id}/mark_read/": { "post": { "operationId": "notifications-v1-notifications-mark-read-create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "notifications" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Notification" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "" } }, "description": "Notifications v1 notifications mark read" } }, "/notifications/v1/notifications/mark_all_read/": { "post": { "operationId": "notifications-v1-notifications-mark-all-read-create", "tags": [ "notifications" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Notification" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "" } }, "description": "Create a new notifications v1 notifications mark all read" } }, "/notifications/v1/notifications/unread_count/": { "get": { "operationId": "notifications-v1-notifications-unread-count-retrieve", "tags": [ "notifications" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "" } }, "description": "Notifications v1 notifications unread count" } }, "/notifications/v1/push/subscribe/": { "post": { "operationId": "notifications-v1-push-subscribe-create", "tags": [ "notifications" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } }, "description": "Notifications v1 push subscribe" } }, "/notifications/v1/push/unsubscribe/": { "post": { "operationId": "notifications-v1-push-unsubscribe-create", "tags": [ "notifications" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } }, "description": "Notifications v1 push unsubscribe" } }, "/notifications/v1/push/vapid_public_key/": { "get": { "operationId": "notifications-v1-push-vapid-public-key-retrieve", "tags": [ "notifications" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } }, "description": "Notifications v1 push vapid public key" } }, "/observability/v1/agent-improvement-sessions/": { "get": { "operationId": "agent-improvement-sessions-list", "description": "Create + poll \"Improve Agent\" sessions from Insights or evaluators.\n\n``create`` resolves the target agent from Insight call logs, simulation\nruns, or selected evaluator scenarios. It validates a VAPI / ElevenLabs\nprovider key and opens Claude Agent SDK runs in product chat. Call-log\nsessions generate evaluators in one sandbox and self-improve in another;\nrun and scenario sessions reuse existing evaluators directly.\n\n``retrieve`` / ``list`` are read-only poll surfaces. Runtime checkpoints\nadvance the workflow and persist the status returned to the frontend.", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentImprovementSession" } } } }, "description": "" } } }, "post": { "operationId": "agent-improvement-sessions-create", "description": "Create + poll \"Improve Agent\" sessions from Insights or evaluators.\n\n``create`` resolves the target agent from Insight call logs, simulation\nruns, or selected evaluator scenarios. It validates a VAPI / ElevenLabs\nprovider key and opens Claude Agent SDK runs in product chat. Call-log\nsessions generate evaluators in one sandbox and self-improve in another;\nrun and scenario sessions reuse existing evaluators directly.\n\n``retrieve`` / ``list`` are read-only poll surfaces. Runtime checkpoints\nadvance the workflow and persist the status returned to the frontend.", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentImprovementSession" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AgentImprovementSession" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AgentImprovementSession" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentImprovementSession" } } }, "description": "" } } } }, "/observability/v1/agent-improvement-sessions/{id}/": { "get": { "operationId": "agent-improvement-sessions-retrieve", "description": "Create + poll \"Improve Agent\" sessions from Insights or evaluators.\n\n``create`` resolves the target agent from Insight call logs, simulation\nruns, or selected evaluator scenarios. It validates a VAPI / ElevenLabs\nprovider key and opens Claude Agent SDK runs in product chat. Call-log\nsessions generate evaluators in one sandbox and self-improve in another;\nrun and scenario sessions reuse existing evaluators directly.\n\n``retrieve`` / ``list`` are read-only poll surfaces. Runtime checkpoints\nadvance the workflow and persist the status returned to the frontend.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this agent improvement session.", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentImprovementSession" } } }, "description": "" } } } }, "/observability/v1/agent-improvement-sessions/{id}/stream-token/": { "get": { "operationId": "agent-improvement-sessions-stream-token-retrieve", "description": "Mint a one-run SSE token for the live Cekura chat handoff.\n\nThe improvement worker remains detached from the browser. This\nendpoint only lets an authorized browser attach to the already-running\nproduct-chat stream; it does not start, stop, or otherwise control the\nsandbox. It uses the same in-memory replay behavior as ordinary chat.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this agent improvement session.", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentImprovementSession" } } }, "description": "" } } } }, "/observability/v1/alerts/": { "get": { "operationId": "alerts-list", "description": "Return all alerts configured in the project, including their sub_type (`normal` | `significant_change` | `threshold`), source metric, current Slack/notification config, and trigger counters. Use before creating a new alert to check if one already exists on the same metric.", "summary": "List alerts in a project", "parameters": [ { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "Project this alert belongs to" }, { "in": "query", "name": "source_type", "schema": { "type": "string", "x-spec-enum-id": "2713692dc60667c9", "enum": [ "metric" ] }, "description": "Type of data source: metric, duration, call_volume, etc.\n\n* `metric` - Metric" }, { "in": "query", "name": "enabled", "schema": { "type": "boolean" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } } ], "tags": [ "observability" ], "security": [ { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlertList" } } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "alerts-list", "description": "Return all alerts configured in the project, including their sub_type (`normal` | `significant_change` | `threshold`), source metric, current Slack/notification config, and trigger counters. Use before creating a new alert to check if one already exists on the same metric." } } }, "post": { "operationId": "alerts-create", "description": "Create an alert that fires when a metric crosses a threshold. Three sub_types:\n\n- `normal` — Failure alert. Fires per failing call. Only for binary metrics (eval_type starts with `binary_`) plus the latency / infrastructure / critical-deviation built-ins.\n- `significant_change` — Trend alert. Fires when a numeric/continuous metric's rolling mean deviates from history. Pass `preset: \"balanced\"` (or `\"conservative\"` / `\"aggressive\"`) to skip manual std_multiplier / ewma_alpha / window_size math — the server expands the preset. Balanced is the safe default.\n- `threshold` — Hard ceiling/floor. Fires when ≥ `min_breaches` of the last `window_size` evaluations cross `value`. Use for numeric metrics where the user has a known good range. Operator is `gt` | `lt` | `outside` ({low, high}).\n\n**Slack delivery requires** `notifications.slack.workspace_id` (+ optional `channel_id`). Alerts with empty `notifications` are silent — fire counters still increment but no message is sent. Pick a workspace_id from `slack_workspaces_list`.", "summary": "Create an alert on a metric", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertCreate" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AlertCreate" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AlertCreate" } } }, "required": true }, "security": [ { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertCreate" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "alerts-create", "description": "Create an alert that fires when a metric crosses a threshold. Three sub_types:\n\n- `normal` — Failure alert. Fires per failing call. Only for binary metrics (eval_type starts with `binary_`) plus the latency / infrastructure / critical-deviation built-ins.\n- `significant_change` — Trend alert. Fires when a numeric/continuous metric's rolling mean deviates from history. Pass `preset: \"balanced\"` (or `\"conservative\"` / `\"aggressive\"`) to skip manual std_multiplier / ewma_alpha / window_size math — the server expands the preset. Balanced is the safe default.\n- `threshold` — Hard ceiling/floor. Fires when ≥ `min_breaches` of the last `window_size` evaluations cross `value`. Use for numeric metrics where the user has a known good range. Operator is `gt` | `lt` | `outside` ({low, high}).\n\n**Slack delivery requires** `notifications.slack.workspace_id` (+ optional `channel_id`). Alerts with empty `notifications` are silent — fire counters still increment but no message is sent. Pick a workspace_id from `slack_workspaces_list`." } } } }, "/observability/v1/alerts/{id}/": { "get": { "operationId": "alerts-retrieve", "description": "Return one alert with its source / threshold / notifications JSON expanded. Use this before updating to confirm the current shape — `partial_update` merges into existing JSON, so you need to know what's already there.", "summary": "Get an alert's full config", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alert.", "required": true } ], "tags": [ "observability" ], "security": [ { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDetail" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "alerts-retrieve", "description": "Return one alert with its source / threshold / notifications JSON expanded. Use this before updating to confirm the current shape — `partial_update` merges into existing JSON, so you need to know what's already there." } } }, "put": { "operationId": "alerts-update", "description": "Manage alerts that fire when metric thresholds are crossed.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alert.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertUpdate" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AlertUpdate" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AlertUpdate" } } }, "required": true }, "security": [ { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertUpdate" } } }, "description": "" } } }, "patch": { "operationId": "alerts-partial-update", "description": "Update fields on an existing alert. Common uses from chat:\n\n- Tune sensitivity: pass `preset: \"conservative\"` to make a noisy trend alert quieter (or `\"aggressive\"` to catch smaller shifts). Explicit `threshold.std_multiplier` / `ewma_alpha` / `source.window_size` override the preset.\n- Change Slack routing: pass a new `notifications.slack` block.\n- Disable temporarily: pass `enabled: false`.\n\nChanging `sub_type` requires the matching `source` + `threshold` shape — see `alerts_create` for the field matrix per sub_type. Partial updates merge JSON, so omitted nested keys keep their existing values.", "summary": "Update an alert (partial)", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alert.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAlertUpdate" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAlertUpdate" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAlertUpdate" } } } }, "security": [ { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertUpdate" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "alerts-partial-update", "description": "Update fields on an existing alert. Common uses from chat:\n\n- Tune sensitivity: pass `preset: \"conservative\"` to make a noisy trend alert quieter (or `\"aggressive\"` to catch smaller shifts). Explicit `threshold.std_multiplier` / `ewma_alpha` / `source.window_size` override the preset.\n- Change Slack routing: pass a new `notifications.slack` block.\n- Disable temporarily: pass `enabled: false`.\n\nChanging `sub_type` requires the matching `source` + `threshold` shape — see `alerts_create` for the field matrix per sub_type. Partial updates merge JSON, so omitted nested keys keep their existing values." } } }, "delete": { "operationId": "alerts-destroy", "description": "Permanently delete an alert. ⚠ Irreversible. The chat agent refuses this operation at the SDK layer; direct API/SDK callers can still use it.", "summary": "Delete an alert", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alert.", "required": true } ], "tags": [ "observability" ], "security": [ { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } }, "x-mcp-expose": true, "x-mcp-destructive": true, "x-mint": { "mcp": { "enabled": true, "name": "alerts-destroy", "description": "Permanently delete an alert. ⚠ Irreversible. The chat agent refuses this operation at the SDK layer; direct API/SDK callers can still use it." } } } }, "/observability/v1/alerts/{id}/review_detail/": { "get": { "operationId": "alerts-review-detail-retrieve", "description": "Per-alert review data — config snapshot, timeline, paginated fires.\n\nPowers the per-alert review page. Single-alert version of the bulk\n`review` action. Timeline is computed with a DB-side GROUP BY so the\nendpoint stays fast for noisy alerts (thousands of fires in 7d).\n\nQuery params:\n hours: optional, defaults to 24. Capped at 7 days.\n page: optional, defaults to 1.\n page_size: optional, defaults to 50, capped at 200.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alert.", "required": true } ], "tags": [ "observability" ], "security": [ { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDetail" } } }, "description": "" } } } }, "/observability/v1/alerts/{id}/summarize/": { "post": { "operationId": "alerts-summarize-create", "description": "Kick off an LLM summary of the last N hours of fires for this alert.\n\nReturns a progress_id. Frontend polls `summarize_progress` until status\nis 'completed' or 'error'. Cached for 1 hour keyed on (alert, hours,\nlatest fire id) — re-invocations within that window return the same\nprogress_id.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alert.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AlertDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AlertDetail" } } }, "required": true }, "security": [ { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDetail" } } }, "description": "" } } } }, "/observability/v1/alerts/review/": { "get": { "operationId": "alerts-review-retrieve", "description": "Aggregate every alert's fire activity over a rolling window. Returns KPI totals (total fires, unique alerts that fired, top firing alert), a time-bucketed timeline (hourly for 24h, 3-hour for 3d, 6-hour for 7d), and a per-alert breakdown with a sparkline of fires-per-bucket. Use to answer 'what alerts fired this week?' or 'is anything noisy right now?'. Pass `hours` (default 24, capped at 168) to widen the window. The response shape lets you compose a written report in a single call.", "summary": "Review alert activity in a project", "tags": [ "observability" ], "security": [ { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDetail" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "alerts-review-retrieve", "description": "Aggregate every alert's fire activity over a rolling window. Returns KPI totals (total fires, unique alerts that fired, top firing alert), a time-bucketed timeline (hourly for 24h, 3-hour for 3d, 6-hour for 7d), and a per-alert breakdown with a sparkline of fires-per-bucket. Use to answer 'what alerts fired this week?' or 'is anything noisy right now?'. Pass `hours` (default 24, capped at 168) to widen the window. The response shape lets you compose a written report in a single call." } }, "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `project_id` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ] } }, "/observability/v1/alerts/summarize_progress/": { "get": { "operationId": "alerts-summarize-progress-retrieve", "description": "Manage alerts that fire when metric thresholds are crossed.", "tags": [ "observability" ], "security": [ { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDetail" } } }, "description": "" } } } }, "/observability/v1/alerts/trigger_summary/": { "get": { "operationId": "alerts-trigger-summary-retrieve", "description": "Return fire counts per alert over a time window.\n\nPowers the \"Last 24h\" status pill on the alerts list. Counts CallLogAlert\nrows linked to each alert in the project, scoped to the window.\n\nQuery params:\n project_id: required, scopes the result to alerts in this project.\n hours: optional, defaults to 24. Window size in hours.\n\nReturns: { \"\": , ... }", "tags": [ "observability" ], "security": [ { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs/": { "get": { "operationId": "call-logs-list", "description": "List **production** call logs for an agent or project. Production-only — test/simulation runs triggered via `run_scenarios_*` do NOT create call logs; use `results_list` + `runs_bulk_retrieve` for simulation data instead.\n\nAlways pass `agent_id` or `project_id` to scope results — without one, the response may be very large. **`project_id` is required when using an organization-level API key.**\n\n**Time window:** results default to the **last 30 days** when no timestamp range is given. A supplied range must not exceed **31 days** (wider ranges return `400`); pass `timestamp_from`/`timestamp_to` (ISO 8601) to select a window within that limit.\n\n**Filtering:**\n- `timestamp_from` / `timestamp_to` — ISO 8601 date range filter\n- `call_ids` — comma-separated **CallLog IDs** (integer DB IDs of call logs in this list response), e.g. `\"123,456\"`. Distinct from simulation `run_id`s and from each call log's own `call_id` field (which holds the provider's call identifier string).\n- `filters_v2` — structured JSON filter (same format as dashboard filters). Simple: `{\"field\": \"success\", \"op\": \"eq\", \"value\": true}`. Compound: `{\"operator\": \"and\", \"conditions\": [{...}, {...}]}`. Supported operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `startswith`, `in`, `isnull`.", "summary": "List call logs", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "timestamp_from", "schema": { "type": "string", "format": "date-time" }, "description": "\nFilter results from this timestamp (e.g. 2025-01-01T00:00:00Z)\nExample: `2025-01-01T00:00:00Z`\n" }, { "in": "query", "name": "timestamp_to", "schema": { "type": "string", "format": "date-time" }, "description": "\nFilter results to this timestamp (e.g. 2025-01-31T23:59:59Z)\nExample: `2025-01-31T23:59:59Z`\n" }, { "in": "query", "name": "call_ids", "schema": { "type": "string", "minLength": 1 }, "description": "Comma-separated list of call log IDs to filter by. Example: `\"5181749,5181752\"`" }, { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "\nFilter by agent ID. Either agent_id or project_id should be provided.\nExample: `2142`\n" }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "\nFilter by project ID. Either agent_id or project_id should be provided.\n**Required when using an organization-level API key** to scope results to a specific project.\nExample: `1376`\n" }, { "in": "query", "name": "assistant_id", "schema": { "type": "string", "minLength": 1 }, "description": "\nFilter by assistant ID\nExample:\n- `\"asst_1234567890\"`\n- `\"agent_xyz789\"`\n" }, { "in": "query", "name": "filters_v2", "schema": { "type": "string", "minLength": 1 }, "description": "\nAdvanced JSON filters using CallLogQueryFilter format (same as dashboard filters).\nSupports nested AND/OR conditions, field comparisons, and related field filtering.\n\nExample - Simple filter:\n`{\"field\": \"success\", \"op\": \"eq\", \"value\": true}`\n\nExample - AND conditions:\n`{\"operator\": \"and\", \"conditions\": [{\"field\": \"success\", \"op\": \"eq\", \"value\": true}, {\"field\": \"duration\", \"op\": \"gte\", \"value\": 60}]}`\n\nExample - OR conditions:\n`{\"operator\": \"or\", \"conditions\": [{\"field\": \"call_ended_reason\", \"op\": \"eq\", \"value\": \"completed\"}, {\"field\": \"call_ended_reason\", \"op\": \"eq\", \"value\": \"hangup\"}]}`\n\nSupported fields: success, duration, call_id, timestamp, created_at, call_ended_reason, customer_number, etc.\nSupported operators: eq, neq, gt, gte, lt, lte, contains, startswith, in, isnull\n" } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCallLogListList" } } }, "description": "" } }, "deprecated": true }, "post": { "operationId": "call-logs-create", "description": "Create a new call log", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs-external/": { "get": { "operationId": "call-logs-external-list", "description": "List **production** call logs for an agent or project. Production-only — test/simulation runs triggered via `run_scenarios_*` do NOT create call logs; use `results_list` + `runs_bulk_retrieve` for simulation data instead.\n\nAlways pass `agent_id` or `project_id` to scope results — without one, the response may be very large. **`project_id` is required when using an organization-level API key.**\n\n**Time window:** results default to the **last 30 days** when no timestamp range is given. A supplied range must not exceed **31 days** (wider ranges return `400`); pass `timestamp_from`/`timestamp_to` (ISO 8601) to select a window within that limit.\n\n**Filtering:**\n- `timestamp_from` / `timestamp_to` — ISO 8601 date range filter\n- `call_ids` — comma-separated **CallLog IDs** (integer DB IDs of call logs in this list response), e.g. `\"123,456\"`. Distinct from simulation `run_id`s and from each call log's own `call_id` field (which holds the provider's call identifier string).\n- `filters_v2` — structured JSON filter (same format as dashboard filters). Simple: `{\"field\": \"success\", \"op\": \"eq\", \"value\": true}`. Compound: `{\"operator\": \"and\", \"conditions\": [{...}, {...}]}`. Supported operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `startswith`, `in`, `isnull`.", "summary": "List call logs", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "timestamp_from", "schema": { "type": "string", "format": "date-time" }, "description": "\nFilter results from this timestamp (e.g. 2025-01-01T00:00:00Z)\nExample: `2025-01-01T00:00:00Z`\n" }, { "in": "query", "name": "timestamp_to", "schema": { "type": "string", "format": "date-time" }, "description": "\nFilter results to this timestamp (e.g. 2025-01-31T23:59:59Z)\nExample: `2025-01-31T23:59:59Z`\n" }, { "in": "query", "name": "call_ids", "schema": { "type": "string", "minLength": 1 }, "description": "Comma-separated list of call log IDs to filter by. Example: `\"5181749,5181752\"`" }, { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "\nFilter by agent ID. Either agent_id or project_id should be provided.\nExample: `2142`\n" }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "\nFilter by project ID. Either agent_id or project_id should be provided.\n**Required when using an organization-level API key** to scope results to a specific project.\nExample: `1376`\n" }, { "in": "query", "name": "assistant_id", "schema": { "type": "string", "minLength": 1 }, "description": "\nFilter by assistant ID\nExample:\n- `\"asst_1234567890\"`\n- `\"agent_xyz789\"`\n" }, { "in": "query", "name": "filters_v2", "schema": { "type": "string", "minLength": 1 }, "description": "\nAdvanced JSON filters using CallLogQueryFilter format (same as dashboard filters).\nSupports nested AND/OR conditions, field comparisons, and related field filtering.\n\nExample - Simple filter:\n`{\"field\": \"success\", \"op\": \"eq\", \"value\": true}`\n\nExample - AND conditions:\n`{\"operator\": \"and\", \"conditions\": [{\"field\": \"success\", \"op\": \"eq\", \"value\": true}, {\"field\": \"duration\", \"op\": \"gte\", \"value\": 60}]}`\n\nExample - OR conditions:\n`{\"operator\": \"or\", \"conditions\": [{\"field\": \"call_ended_reason\", \"op\": \"eq\", \"value\": \"completed\"}, {\"field\": \"call_ended_reason\", \"op\": \"eq\", \"value\": \"hangup\"}]}`\n\nSupported fields: success, duration, call_id, timestamp, created_at, call_ended_reason, customer_number, etc.\nSupported operators: eq, neq, gt, gte, lt, lte, contains, startswith, in, isnull\n" } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCallLogListList" } } }, "description": "" } }, "deprecated": true }, "post": { "operationId": "call-logs-external-create", "description": "Create a new call log", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs-external/{id}/": { "get": { "operationId": "call-logs-external-retrieve", "description": "Retrieve a production CallLog by its integer **CallLog ID** (path parameter). This is distinct from simulation `run_id` (use `runs_retrieve` for those) and from the call log's own `call_id` string field (the provider's call identifier).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } }, "deprecated": true }, "patch": { "operationId": "observability-v2-call-logs-partial-update", "description": "Updates source data for an existing production call log.\n\n**Supported fields**\n- `call_id` — Provider call identifier. Subject to the organization's duplicate-call-ID policy.\n- `transcript_json` — Structured transcript in a supported provider or Cekura format. Use `transcript_type` to specify the format, or omit it for automatic detection. This replaces both transcript representations.\n- `timestamp` — Call start time in ISO 8601 format.\n- `duration` — Call duration in minutes.\n- `call_ended_reason` and `customer_number` — Provider-supplied call attributes.\n- `metadata` and `dynamic_variables` — JSON objects merged at the top level with the existing values. Supplied keys overwrite matching keys; omitted keys are preserved.\n\n**Restrictions**\nOnly the fields listed above are accepted. System-managed fields, including agent and project ownership, metric evaluations, review state, topic, and dropoff point, cannot be updated.\n\n**Metric evaluation**\nThis operation does not recompute metrics. To evaluate the updated call data, invoke `rerun_evaluation` in a separate request.", "summary": "Update call log source data", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedUpdateCallLog" }, "examples": { "Append-twilio-insights": { "value": { "metadata": { "twilio_insights": { "call_sid": "CA123", "answered_by": "human" } } }, "summary": "Append Twilio Insights metadata" }, "Correct-source-call-data": { "value": { "call_id": "provider-call-123", "duration": 1.5, "call_ended_reason": "customer-ended-call" }, "summary": "Correct provider-supplied call data" }, "Update-structured-transcript": { "value": { "transcript_type": "cekura", "transcript_json": [ { "role": "Testing Agent", "content": "Hello.", "start_time": 0, "end_time": 1 }, { "role": "Main Agent", "content": "How can I help?", "start_time": 1, "end_time": 2.5 } ] }, "summary": "Update a structured transcript" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedUpdateCallLog" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedUpdateCallLog" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } }, "delete": { "operationId": "call-logs-external-destroy", "description": "⚠ Irreversible. Deletes the call log along with its transcript and voice recording. By default metric evaluations are also deleted; set `retain_evaluations=true` to keep them and leave the call record un-soft-deleted.", "summary": "Delete a call log", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true }, { "in": "query", "name": "retain_evaluations", "schema": { "type": "boolean", "default": false }, "description": "If true, metric evaluations are retained and the call log is not soft-deleted. Default: false." } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/observability/v1/call-logs-external/{id}/mark_critical_scenario_wrong/": { "post": { "operationId": "call-logs-external-mark-critical-scenario-wrong-create", "description": "Call logs mark critical scenario wrong", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs-external/{id}/mark_metric_vote/": { "post": { "operationId": "call-logs-external-mark-metric-vote-create", "description": "Record a thumbs-up or thumbs-down vote on a specific metric evaluation for this call log and optionally provide an expected value and free-text feedback. Updates the metric evaluation and marks the call log as reviewed.", "summary": "Submit a metric vote for a call log", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "Call Logs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkMetricVoteCallLogResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/observability/v1/call-logs-external/{id}/unmark_critical_scenario_wrong/": { "post": { "operationId": "call-logs-external-unmark-critical-scenario-wrong-create", "description": "Call logs unmark critical scenario wrong", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs-external/analyze_call_logs/": { "get": { "operationId": "call-logs-external-analyze-call-logs-retrieve", "description": "Analyze call logs using Claude Agent SDK.\n\nClaude uses Read/Bash tools to query the CSV file without loading it into context.\nThis allows analyzing large datasets efficiently.", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs-external/complete-upload/": { "post": { "operationId": "call-logs-external-complete-upload-create", "description": "Call logs complete upload", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs-external/create_scenarios/": { "post": { "operationId": "call-logs-create-scenarios", "description": "Generate test scenarios from real production call logs.\n\nReturns a `progress_id` immediately — the actual scenario creation runs in the background.\nPoll `GET /observability/v1/call-logs/create_scenarios_progress?progress_id=` until\n`completed_scenarios + failed_scenarios >= total_scenarios`. The `scenarios_list` field\n(full Scenario objects) is populated only once processing is complete.\n\n**`call_logs` accepts:** a list of IDs `[1, 2, 3]` or `\"all\"` for every call log on the agent.\n\n**`copy_to_agent`:** optionally copy the generated scenarios to a different agent —\nuseful when your observation agent and your test agent are separate.\n\n**Prerequisite:** call logs must have a transcript (uploaded via `transcript_json`).\nAudio-only logs without a transcript cannot produce scenarios.", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateScenarios" }, "examples": { "Create-scenarios-with-agent-id": { "value": { "agent_id": 2142, "call_logs": [ 1, 2, 3 ], "copy_to_agent": null }, "summary": "create-scenarios-with-agent-id" }, "Create-scenarios-with-assistant-id": { "value": { "assistant_id": "asst_1234567890", "call_logs": "all" }, "summary": "create-scenarios-with-assistant-id" }, "Create-scenarios-with-copy-to-agent": { "value": { "agent_id": 2142, "call_logs": [ 1, 2, 3 ], "copy_to_agent": 2143 }, "summary": "create-scenarios-with-copy-to-agent" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateScenarios" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateScenarios" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "progress_id": { "type": "string", "format": "uuid", "description": "Unique identifier for tracking the progress of scenario creation" } } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/observability/v1/call-logs-external/create_scenarios_progress/": { "get": { "operationId": "call-logs-create-scenarios-progress", "description": "Call logs create scenarios progress", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string", "format": "uuid" }, "description": "Progress ID returned from create_scenarios endpoint", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaCreateScenariosProgressResponse" }, "examples": { "Progress-in-progress": { "value": { "agent_id": 2142, "completed_scenarios": 2, "failed_scenarios": 0, "total_scenarios": 5, "scenarios_list": [], "errors": [] }, "summary": "progress-in-progress" }, "Progress-completed": { "value": { "agent_id": 2142, "completed_scenarios": 4, "failed_scenarios": 1, "total_scenarios": 5, "scenarios_list": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier for the scenario" }, "name": { "type": "string", "description": "Name of the scenario" }, "agent": { "type": "integer", "description": "ID of the AI agent this scenario belongs to" }, "assistant_id": { "type": "string", "description": "Alternative to agent ID - the assistant ID to use for this scenario" }, "personality": { "type": "integer", "description": "ID of the personality used in this scenario" }, "personality_name": { "type": "string", "description": "Name of the personality used in this scenario" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags associated with this scenario." }, "runs": { "type": "array", "items": { "type": "integer" }, "description": "List of IDs for the last run of this scenario" }, "metrics": { "type": "array", "items": { "type": "integer" }, "description": "List of metric IDs to associate with this scenario" }, "metric_names": { "type": "array", "items": { "type": "string" }, "description": "List of metric names associated with this scenario" }, "phone_number": { "type": "string", "description": "Phone number used for outbound calls in this scenario" }, "phone_number_queue_length": { "type": "integer", "description": "Number of runs in queue for this phone number" }, "first_message": { "type": "string", "description": "First message to be sent in the scenario" }, "inbound_phone_number": { "type": "integer", "description": "ID of the phone number used for inbound calls" }, "inbound_phone_number_data": { "type": "object", "description": "Details of the phone number used for inbound calls", "properties": { "id": { "type": "integer", "description": "ID of the inbound phone number" }, "number": { "type": "string", "description": "The actual phone number" }, "phone_number_id": { "type": "string", "description": "External ID of the phone number" } } }, "instructions": { "type": "string", "description": "Instructions for the AI agent in this scenario" }, "simulation_description": { "type": "string", "description": "Description of the simulation if this scenario was created by simulation" }, "information_fields": { "type": "object", "description": "Additional information fields for the scenario" }, "expected_outcome_prompt": { "type": "string", "description": "Expected outcome prompt for the scenario" }, "scenario_language": { "type": "string", "description": "Language of the scenario" }, "is_simulating": { "type": "boolean", "description": "Whether this scenario was created by simulation" }, "test_profile_data": { "type": "object", "description": "The test profile generated for this scenario, including its sectioned `information` (main_agent_variables / testing_agent_variables)" }, "generated_mock_tool_entries": { "type": "array", "description": "Expected mock tool calls generated for this scenario when the agent has mock tools attached. Empty when the agent has no mock tools.", "items": { "type": "object", "properties": { "tool_id": { "type": "integer", "description": "ID of the mock tool on the agent" }, "tool_name": { "type": "string", "description": "Name of the tool being mocked" }, "new_entry": { "type": "object", "description": "The expected tool call for this scenario", "properties": { "input": { "type": "object", "description": "Input parameters the tool call is expected to receive" }, "output": { "type": "object", "description": "Response the mock tool will return" } } } } } } } } }, "errors": [ { "call_log_id": 3, "error": { "detail": "Transcript is missing" } } ] }, "summary": "progress-completed" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/observability/v1/call-logs-external/delete_call_logs/": { "post": { "operationId": "call-logs-bulk-delete", "description": "Call logs bulk delete", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCallLogs" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DeleteCallLogs" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DeleteCallLogs" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/observability/v1/call-logs-external/evaluate_metrics/": { "post": { "operationId": "call-logs-external-evaluate-metrics-create", "description": "Evaluate one or more metrics against selected call logs. Unlike `rerun_evaluation` (which re-runs all assigned metrics), this endpoint lets you target specific metrics.\n\n**Scope:** provide either `agent_id` or `project_id` to identify which agent's call logs and metrics to use. Metrics must belong to the specified agent or project.\n\n**Credit check:** cost scales with the number of call logs and metrics selected. The request is rejected if your balance is insufficient — check your balance first via `test_framework_billing_info_retrieve`.\n\n**Async:** evaluation runs in the background. The response returns the call logs in their current state. Retrieve each call log individually to see updated metric results once evaluation completes.\n\n**Rate limited.** Respect 429 responses — wait for the `Retry-After` duration.", "summary": "Run specific metrics against call logs", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateMetrics" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EvaluateMetrics" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/EvaluateMetrics" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallLogList" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/observability/v1/call-logs-external/export_call_logs/": { "get": { "operationId": "call-logs-external-export-call-logs-retrieve", "description": "Call logs export call logs", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs-external/export_call_logs_progress/": { "get": { "operationId": "call-logs-external-export-call-logs-progress-retrieve", "description": "Call logs export call logs progress", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs-external/filters/": { "get": { "operationId": "call-logs-external-filters-retrieve", "description": "Call logs filters", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs-external/filters_call_id/": { "get": { "operationId": "call-logs-external-filters-call-id-retrieve", "description": "Autocomplete-search the production CallLog `call_id` field (the provider's call identifier string). This is distinct from simulation `run_id` (integer; see `runs_list`) and from CallLog ID (integer DB ID).", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs-external/filters_customer_number/": { "get": { "operationId": "call-logs-external-filters-customer-number-retrieve", "description": "Call logs filters customer number", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs-external/get-upload-url/": { "post": { "operationId": "call-logs-external-get-upload-url-create", "description": "Call logs get upload url", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs-external/rerun_evaluation/": { "post": { "operationId": "call-logs-external-rerun-evaluation-create", "description": "Trigger metric re-evaluation on one or more existing call logs. Provide either `agent_id` or `assistant_id` (not both) to identify the agent, then specify which call logs to re-evaluate.\n\n**`call_logs` accepts:**\n- A list of call log IDs: `[1, 2, 3]`\n- The string `\"all\"` to re-evaluate every call log for the agent\n\n**Side effect:** for non-reviewed call logs, `success` is reset to `null` before re-evaluation begins. Reviewed call logs retain their human-approved outcome.\n\n**Rate limited.** If the limit is exceeded you will receive a 429 response — wait for the `Retry-After` duration before retrying.", "summary": "Re-run metric evaluation on call logs", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RerunEvaluation" }, "examples": { "Re-evaluate-specific-call-logs": { "value": { "agent_id": 2142, "call_logs": [ 101, 102, 103 ] }, "summary": "re-evaluate-specific-call-logs" }, "Re-evaluate-all-call-logs": { "value": { "agent_id": 2142, "call_logs": "all" }, "summary": "re-evaluate-all-call-logs" }, "Re-evaluate-using-assistant-id": { "value": { "assistant_id": 2143, "call_logs": [ 101, 102 ] }, "summary": "re-evaluate-using-assistant-id" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RerunEvaluation" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RerunEvaluation" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallLogDetail" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/observability/v1/call-logs/{id}/": { "get": { "operationId": "call-logs-retrieve", "description": "Retrieve a production CallLog by its integer **CallLog ID** (path parameter). This is distinct from simulation `run_id` (use `runs_retrieve` for those) and from the call log's own `call_id` string field (the provider's call identifier).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } }, "deprecated": true }, "patch": { "operationId": "observability-v2-call-logs-partial-update_2", "description": "Updates source data for an existing production call log.\n\n**Supported fields**\n- `call_id` — Provider call identifier. Subject to the organization's duplicate-call-ID policy.\n- `transcript_json` — Structured transcript in a supported provider or Cekura format. Use `transcript_type` to specify the format, or omit it for automatic detection. This replaces both transcript representations.\n- `timestamp` — Call start time in ISO 8601 format.\n- `duration` — Call duration in minutes.\n- `call_ended_reason` and `customer_number` — Provider-supplied call attributes.\n- `metadata` and `dynamic_variables` — JSON objects merged at the top level with the existing values. Supplied keys overwrite matching keys; omitted keys are preserved.\n\n**Restrictions**\nOnly the fields listed above are accepted. System-managed fields, including agent and project ownership, metric evaluations, review state, topic, and dropoff point, cannot be updated.\n\n**Metric evaluation**\nThis operation does not recompute metrics. To evaluate the updated call data, invoke `rerun_evaluation` in a separate request.", "summary": "Update call log source data", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedUpdateCallLog" }, "examples": { "Append-twilio-insights": { "value": { "metadata": { "twilio_insights": { "call_sid": "CA123", "answered_by": "human" } } }, "summary": "Append Twilio Insights metadata" }, "Correct-source-call-data": { "value": { "call_id": "provider-call-123", "duration": 1.5, "call_ended_reason": "customer-ended-call" }, "summary": "Correct provider-supplied call data" }, "Update-structured-transcript": { "value": { "transcript_type": "cekura", "transcript_json": [ { "role": "Testing Agent", "content": "Hello.", "start_time": 0, "end_time": 1 }, { "role": "Main Agent", "content": "How can I help?", "start_time": 1, "end_time": 2.5 } ] }, "summary": "Update a structured transcript" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedUpdateCallLog" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedUpdateCallLog" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } }, "delete": { "operationId": "call-logs-destroy", "description": "⚠ Irreversible. Deletes the call log along with its transcript and voice recording. By default metric evaluations are also deleted; set `retain_evaluations=true` to keep them and leave the call record un-soft-deleted.", "summary": "Delete a call log", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true }, { "in": "query", "name": "retain_evaluations", "schema": { "type": "boolean", "default": false }, "description": "If true, metric evaluations are retained and the call log is not soft-deleted. Default: false." } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/observability/v1/call-logs/{id}/mark_critical_scenario_wrong/": { "post": { "operationId": "call-logs-mark-critical-scenario-wrong-create", "description": "Call logs mark critical scenario wrong", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs/{id}/mark_metric_vote/": { "post": { "operationId": "call-logs-mark-metric-vote-create", "description": "Record a thumbs-up or thumbs-down vote on a specific metric evaluation for this call log and optionally provide an expected value and free-text feedback. Updates the metric evaluation and marks the call log as reviewed.", "summary": "Submit a metric vote for a call log", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "Call Logs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkMetricVoteCallLogResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/observability/v1/call-logs/{id}/trace/": { "get": { "operationId": "call-logs-trace-retrieve", "description": "Retrieve the raw OpenTelemetry trace associated with a production call log.\n\nBefore calling this tool, retrieve or list the call log and confirm that its `trace_id` is non-empty; an empty `trace_id` means no trace is available. Pass the call log's integer `id`, not its provider `call_id` or its `trace_id`.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogTraceResponse" } } }, "description": "" }, "404": { "description": "The call log does not exist, has no trace ID, or its trace was not found." } }, "x-mcp-expose": true, "summary": "Get a call log's trace", "x-mint": { "mcp": { "enabled": true, "name": "call-logs-trace-retrieve", "description": "Retrieve the raw OpenTelemetry trace associated with a production call log.\n\nBefore calling this tool, retrieve or list the call log and confirm that its `trace_id` is non-empty; an empty `trace_id` means no trace is available. Pass the call log's integer `id`, not its provider `call_id` or its `trace_id`." } } } }, "/observability/v1/call-logs/{id}/unmark_critical_scenario_wrong/": { "post": { "operationId": "call-logs-unmark-critical-scenario-wrong-create", "description": "Call logs unmark critical scenario wrong", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs/analyze_call_logs/": { "get": { "operationId": "call-logs-analyze-call-logs-retrieve", "description": "Analyze call logs using Claude Agent SDK.\n\nClaude uses Read/Bash tools to query the CSV file without loading it into context.\nThis allows analyzing large datasets efficiently.", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs/complete-upload/": { "post": { "operationId": "call-logs-complete-upload-create", "description": "Call logs complete upload", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs/create_scenarios/": { "post": { "operationId": "call-logs-create-scenarios_2", "description": "Generate test scenarios from real production call logs.\n\nReturns a `progress_id` immediately — the actual scenario creation runs in the background.\nPoll `GET /observability/v1/call-logs/create_scenarios_progress?progress_id=` until\n`completed_scenarios + failed_scenarios >= total_scenarios`. The `scenarios_list` field\n(full Scenario objects) is populated only once processing is complete.\n\n**`call_logs` accepts:** a list of IDs `[1, 2, 3]` or `\"all\"` for every call log on the agent.\n\n**`copy_to_agent`:** optionally copy the generated scenarios to a different agent —\nuseful when your observation agent and your test agent are separate.\n\n**Prerequisite:** call logs must have a transcript (uploaded via `transcript_json`).\nAudio-only logs without a transcript cannot produce scenarios.", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateScenarios" }, "examples": { "Create-scenarios-with-agent-id": { "value": { "agent_id": 2142, "call_logs": [ 1, 2, 3 ], "copy_to_agent": null }, "summary": "create-scenarios-with-agent-id" }, "Create-scenarios-with-assistant-id": { "value": { "assistant_id": "asst_1234567890", "call_logs": "all" }, "summary": "create-scenarios-with-assistant-id" }, "Create-scenarios-with-copy-to-agent": { "value": { "agent_id": 2142, "call_logs": [ 1, 2, 3 ], "copy_to_agent": 2143 }, "summary": "create-scenarios-with-copy-to-agent" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateScenarios" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateScenarios" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "progress_id": { "type": "string", "format": "uuid", "description": "Unique identifier for tracking the progress of scenario creation" } } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/observability/v1/call-logs/create_scenarios_progress/": { "get": { "operationId": "call-logs-create-scenarios-progress_2", "description": "Call logs create scenarios progress", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string", "format": "uuid" }, "description": "Progress ID returned from create_scenarios endpoint", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaCreateScenariosProgressResponse" }, "examples": { "Progress-in-progress": { "value": { "agent_id": 2142, "completed_scenarios": 2, "failed_scenarios": 0, "total_scenarios": 5, "scenarios_list": [], "errors": [] }, "summary": "progress-in-progress" }, "Progress-completed": { "value": { "agent_id": 2142, "completed_scenarios": 4, "failed_scenarios": 1, "total_scenarios": 5, "scenarios_list": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier for the scenario" }, "name": { "type": "string", "description": "Name of the scenario" }, "agent": { "type": "integer", "description": "ID of the AI agent this scenario belongs to" }, "assistant_id": { "type": "string", "description": "Alternative to agent ID - the assistant ID to use for this scenario" }, "personality": { "type": "integer", "description": "ID of the personality used in this scenario" }, "personality_name": { "type": "string", "description": "Name of the personality used in this scenario" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags associated with this scenario." }, "runs": { "type": "array", "items": { "type": "integer" }, "description": "List of IDs for the last run of this scenario" }, "metrics": { "type": "array", "items": { "type": "integer" }, "description": "List of metric IDs to associate with this scenario" }, "metric_names": { "type": "array", "items": { "type": "string" }, "description": "List of metric names associated with this scenario" }, "phone_number": { "type": "string", "description": "Phone number used for outbound calls in this scenario" }, "phone_number_queue_length": { "type": "integer", "description": "Number of runs in queue for this phone number" }, "first_message": { "type": "string", "description": "First message to be sent in the scenario" }, "inbound_phone_number": { "type": "integer", "description": "ID of the phone number used for inbound calls" }, "inbound_phone_number_data": { "type": "object", "description": "Details of the phone number used for inbound calls", "properties": { "id": { "type": "integer", "description": "ID of the inbound phone number" }, "number": { "type": "string", "description": "The actual phone number" }, "phone_number_id": { "type": "string", "description": "External ID of the phone number" } } }, "instructions": { "type": "string", "description": "Instructions for the AI agent in this scenario" }, "simulation_description": { "type": "string", "description": "Description of the simulation if this scenario was created by simulation" }, "information_fields": { "type": "object", "description": "Additional information fields for the scenario" }, "expected_outcome_prompt": { "type": "string", "description": "Expected outcome prompt for the scenario" }, "scenario_language": { "type": "string", "description": "Language of the scenario" }, "is_simulating": { "type": "boolean", "description": "Whether this scenario was created by simulation" }, "test_profile_data": { "type": "object", "description": "The test profile generated for this scenario, including its sectioned `information` (main_agent_variables / testing_agent_variables)" }, "generated_mock_tool_entries": { "type": "array", "description": "Expected mock tool calls generated for this scenario when the agent has mock tools attached. Empty when the agent has no mock tools.", "items": { "type": "object", "properties": { "tool_id": { "type": "integer", "description": "ID of the mock tool on the agent" }, "tool_name": { "type": "string", "description": "Name of the tool being mocked" }, "new_entry": { "type": "object", "description": "The expected tool call for this scenario", "properties": { "input": { "type": "object", "description": "Input parameters the tool call is expected to receive" }, "output": { "type": "object", "description": "Response the mock tool will return" } } } } } } } } }, "errors": [ { "call_log_id": 3, "error": { "detail": "Transcript is missing" } } ] }, "summary": "progress-completed" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/observability/v1/call-logs/delete_call_logs/": { "post": { "operationId": "call-logs-bulk-delete_2", "description": "Call logs bulk delete", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCallLogs" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DeleteCallLogs" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DeleteCallLogs" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/observability/v1/call-logs/evaluate_metrics/": { "post": { "operationId": "call-logs-evaluate-metrics-create", "description": "Evaluate one or more metrics against selected call logs. Unlike `rerun_evaluation` (which re-runs all assigned metrics), this endpoint lets you target specific metrics.\n\n**Scope:** provide either `agent_id` or `project_id` to identify which agent's call logs and metrics to use. Metrics must belong to the specified agent or project.\n\n**Credit check:** cost scales with the number of call logs and metrics selected. The request is rejected if your balance is insufficient — check your balance first via `test_framework_billing_info_retrieve`.\n\n**Async:** evaluation runs in the background. The response returns the call logs in their current state. Retrieve each call log individually to see updated metric results once evaluation completes.\n\n**Rate limited.** Respect 429 responses — wait for the `Retry-After` duration.", "summary": "Run specific metrics against call logs", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateMetrics" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EvaluateMetrics" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/EvaluateMetrics" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallLogList" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/observability/v1/call-logs/export_call_logs/": { "get": { "operationId": "call-logs-export-call-logs-retrieve", "description": "Call logs export call logs", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs/export_call_logs_progress/": { "get": { "operationId": "call-logs-export-call-logs-progress-retrieve", "description": "Call logs export call logs progress", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs/filters/": { "get": { "operationId": "call-logs-filters-retrieve", "description": "Call logs filters", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs/filters_call_id/": { "get": { "operationId": "call-logs-filters-call-id-retrieve", "description": "Autocomplete-search the production CallLog `call_id` field (the provider's call identifier string). This is distinct from simulation `run_id` (integer; see `runs_list`) and from CallLog ID (integer DB ID).", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs/filters_customer_number/": { "get": { "operationId": "call-logs-filters-customer-number-retrieve", "description": "Call logs filters customer number", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs/get-upload-url/": { "post": { "operationId": "call-logs-get-upload-url-create", "description": "Call logs get upload url", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v1/call-logs/rerun_evaluation/": { "post": { "operationId": "call-logs-rerun-evaluation-create", "description": "Trigger metric re-evaluation on one or more existing call logs. Provide either `agent_id` or `assistant_id` (not both) to identify the agent, then specify which call logs to re-evaluate.\n\n**`call_logs` accepts:**\n- A list of call log IDs: `[1, 2, 3]`\n- The string `\"all\"` to re-evaluate every call log for the agent\n\n**Side effect:** for non-reviewed call logs, `success` is reset to `null` before re-evaluation begins. Reviewed call logs retain their human-approved outcome.\n\n**Rate limited.** If the limit is exceeded you will receive a 429 response — wait for the `Retry-After` duration before retrying.", "summary": "Re-run metric evaluation on call logs", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RerunEvaluation" }, "examples": { "Re-evaluate-specific-call-logs": { "value": { "agent_id": 2142, "call_logs": [ 101, 102, 103 ] }, "summary": "re-evaluate-specific-call-logs" }, "Re-evaluate-all-call-logs": { "value": { "agent_id": 2142, "call_logs": "all" }, "summary": "re-evaluate-all-call-logs" }, "Re-evaluate-using-assistant-id": { "value": { "assistant_id": 2143, "call_logs": [ 101, 102 ] }, "summary": "re-evaluate-using-assistant-id" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RerunEvaluation" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RerunEvaluation" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallLogDetail" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/observability/v1/chat-sessions/": { "get": { "operationId": "chat-sessions-list", "description": "List conversational RAG chat sessions", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "observability" ], "security": [ { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedChatSessionListList" } } }, "description": "" } } }, "post": { "operationId": "chat-sessions-create", "description": "Create a new conversational RAG chat session", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionCreate" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ChatSessionCreate" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ChatSessionCreate" } } } }, "security": [ { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionCreate" } } }, "description": "" } } } }, "/observability/v1/chat-sessions/{id}/": { "get": { "operationId": "chat-sessions-retrieve", "description": "Retrieve a conversational RAG chat session by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid", "description": "Unique identifier for the chat session.\nExample: `550e8400-e29b-41d4-a716-446655440000`" }, "required": true } ], "tags": [ "observability" ], "security": [ { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDetail" } } }, "description": "" } } }, "put": { "operationId": "chat-sessions-update", "description": "Update a conversational RAG chat session", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid", "description": "Unique identifier for the chat session.\nExample: `550e8400-e29b-41d4-a716-446655440000`" }, "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ChatSessionDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ChatSessionDetail" } } } }, "security": [ { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDetail" } } }, "description": "" } } }, "patch": { "operationId": "chat-sessions-partial-update", "description": "Update a conversational RAG chat session", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid", "description": "Unique identifier for the chat session.\nExample: `550e8400-e29b-41d4-a716-446655440000`" }, "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedChatSessionDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedChatSessionDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedChatSessionDetail" } } } }, "security": [ { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDetail" } } }, "description": "" } } }, "delete": { "operationId": "chat-sessions-destroy", "description": "Delete a conversational RAG chat session", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid", "description": "Unique identifier for the chat session.\nExample: `550e8400-e29b-41d4-a716-446655440000`" }, "required": true } ], "tags": [ "observability" ], "security": [ { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/observability/v1/chat-sessions/{id}/ask/": { "post": { "operationId": "chat-sessions-ask-create", "description": "Send a message in the chat session with streaming response using Claude Agent SDK.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid", "description": "Unique identifier for the chat session.\nExample: `550e8400-e29b-41d4-a716-446655440000`" }, "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ChatSessionDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ChatSessionDetail" } } } }, "security": [ { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionDetail" } } }, "description": "" } } } }, "/observability/v1/deep-research-insights/": { "get": { "operationId": "deep-research-insights-list", "description": "List deep research insights", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeepResearchInsight" } } } }, "description": "" } } } }, "/observability/v1/deep-research-insights/{id}/": { "get": { "operationId": "deep-research-insights-retrieve", "description": "Retrieve a deep research insight by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this deep research insight.", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeepResearchInsight" } } }, "description": "" } } }, "delete": { "operationId": "deep-research-insights-destroy", "description": "Delete a deep research insight", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this deep research insight.", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/observability/v1/deep-research-insights/dismiss_mode/": { "post": { "operationId": "deep-research-insights-dismiss-mode-create", "description": "Suppress one Deep Research failure mode across the project — matched by `mode_title`, it is hidden from every subsequent render of every insight in the project. Scope with `project`; `note` is optional. ⚠ There is no undo via this API.", "summary": "Dismiss a Deep Research failure mode", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeepResearchModeDismissalCreate" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DeepResearchModeDismissalCreate" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DeepResearchModeDismissalCreate" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeepResearchModeDismissalCreate" } } }, "description": "" } }, "x-mcp-expose": true, "x-mcp-destructive": true, "x-mint": { "mcp": { "enabled": true, "name": "deep-research-insights-dismiss-mode-create", "description": "Suppress one Deep Research failure mode across the project — matched by `mode_title`, it is hidden from every subsequent render of every insight in the project. Scope with `project`; `note` is optional. ⚠ There is no undo via this API." } } } }, "/observability/v1/deep-research-insights/generate/": { "post": { "operationId": "deep-research-insights-generate-create", "description": "Queue a project-level Deep Research audit over recent calls and return the new row in `pending`. Scope with `project`; tune the lookback with `window_days` and the sample ceiling with `max_calls`. Poll the returned row's `status` until it reaches `succeeded`. ⚠ Consumes credits per audit — see the pricing endpoint.", "summary": "Generate a Deep Research audit for a project", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeepResearchInsightGenerate" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DeepResearchInsightGenerate" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DeepResearchInsightGenerate" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeepResearchInsightGenerate" } } }, "description": "" } }, "x-mcp-expose": true, "x-mcp-destructive": true, "x-mint": { "mcp": { "enabled": true, "name": "deep-research-insights-generate-create", "description": "Queue a project-level Deep Research audit over recent calls and return the new row in `pending`. Scope with `project`; tune the lookback with `window_days` and the sample ceiling with `max_calls`. Poll the returned row's `status` until it reaches `succeeded`. ⚠ Consumes credits per audit — see the pricing endpoint." } } } }, "/observability/v1/deep-research-insights/pricing/": { "get": { "operationId": "deep-research-insights-pricing-retrieve", "description": "Return the flat credit cost of generating a Deep Research audit. Scope with `project`. Check this before `generate` to know the charge.", "summary": "Get the credit cost of a Deep Research audit", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeepResearchInsight" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "deep-research-insights-pricing-retrieve", "description": "Return the flat credit cost of generating a Deep Research audit. Scope with `project`. Check this before `generate` to know the charge." } }, "parameters": [ { "name": "project", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `project` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ] } }, "/observability/v1/insight-reproduction-sessions/": { "get": { "operationId": "insight-reproduction-sessions-list", "description": "Return reproduction sessions for a project, newest first. Each session tracks the attempt to reproduce a metric failure mode by running a drafted scenario against the agent. Scope with `project`.", "summary": "List insight reproduction sessions", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InsightReproductionSession" } } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "insight-reproduction-sessions-list", "description": "Return reproduction sessions for a project, newest first. Each session tracks the attempt to reproduce a metric failure mode by running a drafted scenario against the agent. Scope with `project`." } }, "parameters": [ { "name": "project", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `project` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ] } }, "/observability/v1/insight-reproduction-sessions/{id}/": { "get": { "operationId": "insight-reproduction-sessions-retrieve", "description": "Return a single reproduction session with its `status`, attempts made, and — once reproduced — the run and result that reproduced the failure. Poll this after calling reproduce on an insight.", "summary": "Get one insight reproduction session", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this insight reproduction session.", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsightReproductionSession" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "insight-reproduction-sessions-retrieve", "description": "Return a single reproduction session with its `status`, attempts made, and — once reproduced — the run and result that reproduced the failure. Poll this after calling reproduce on an insight." } } } }, "/observability/v1/livekit/observe/": { "post": { "operationId": "livekit-observe-create", "description": "Ingest a LiveKit agent-session webhook.\n\nPoint your LiveKit Agents deployment's post-session webhook at this URL. The raw\nwebhook body (with `agent_id`, `session_id`, `egress_s3_key`, etc.) is stored as a\nCallLog; Cekura then fetches the transcript + recording from your S3 egress and\nschedules metric evaluation asynchronously.\n\n**Use this instead of `POST /observability/v1/observe/`** when your agent runs on\nLiveKit Agents and you'd rather wire up the provider's native webhook than assemble\nthe generic CallLog payload yourself.", "tags": [ "observability" ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/observability/v1/metric-failure-mode-insights/": { "get": { "operationId": "metric-failure-mode-insights-list", "description": "Return generated failure-mode insights for a project, newest first. Each insight groups a metric's failing calls into named failure modes with example call ids. Scope with `project` (required); optionally filter by `metric_name`, a single `date` (YYYY-MM-DD), or pass `latest_only=true` for one row per metric. Use before `generate` to check for an existing insight.", "summary": "List metric failure-mode insights", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetricFailureModeInsight" } } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-list", "description": "Return generated failure-mode insights for a project, newest first. Each insight groups a metric's failing calls into named failure modes with example call ids. Scope with `project` (required); optionally filter by `metric_name`, a single `date` (YYYY-MM-DD), or pass `latest_only=true` for one row per metric. Use before `generate` to check for an existing insight." } }, "parameters": [ { "name": "project", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `project` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ] } }, "/observability/v1/metric-failure-mode-insights/{id}/": { "get": { "operationId": "metric-failure-mode-insights-retrieve", "description": "Return a single failure-mode insight with its full failure_modes list. Read this to pick a `failure_mode_index` before calling generate-scenario, reproduce, or fix-metric.", "summary": "Get one metric failure-mode insight", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric failure mode insight.", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsight" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-retrieve", "description": "Return a single failure-mode insight with its full failure_modes list. Read this to pick a `failure_mode_index` before calling generate-scenario, reproduce, or fix-metric." } } }, "delete": { "operationId": "metric-failure-mode-insights-destroy", "description": "Permanently delete one failure-mode insight. ⚠ Cannot be undone.", "summary": "Delete a metric failure-mode insight", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric failure mode insight.", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } }, "x-mcp-expose": true, "x-mcp-destructive": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-destroy", "description": "Permanently delete one failure-mode insight. ⚠ Cannot be undone." } } } }, "/observability/v1/metric-failure-mode-insights/{id}/failure-mode-agents/": { "get": { "operationId": "metric-failure-mode-insights-failure-mode-agents-retrieve", "description": "Return the agents whose calls appear in one failure mode's example calls, with a per-agent call count. Select the failure mode with the `index` query parameter. Use this to choose the `agent` for generate-scenario or reproduce; falls back to the project's agents when no example call resolves to an agent.", "summary": "List agents implicated by a failure mode", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric failure mode insight.", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsight" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-failure-mode-agents-retrieve", "description": "Return the agents whose calls appear in one failure mode's example calls, with a per-agent call count. Select the failure mode with the `index` query parameter. Use this to choose the `agent` for generate-scenario or reproduce; falls back to the project's agents when no example call resolves to an agent." } } } }, "/observability/v1/metric-failure-mode-insights/{id}/fix-metric/": { "post": { "operationId": "metric-failure-mode-insights-fix-metric-create", "description": "Sample a few of one failure mode's example calls and add them to Labs as metric reviews for the insight's metric, with `feedback` as the note and an optional corrected `expected_value` label (defaults to a pass). Select the failure mode with `failure_mode_index`. Overwrites any existing review for the same calls on this metric.", "summary": "Add a failure mode's example calls to Labs", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric failure mode insight.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeFixMetric" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricFailureModeFixMetric" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricFailureModeFixMetric" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeFixMetric" } } }, "description": "" } }, "x-mcp-expose": true, "x-mcp-destructive": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-fix-metric-create", "description": "Sample a few of one failure mode's example calls and add them to Labs as metric reviews for the insight's metric, with `feedback` as the note and an optional corrected `expected_value` label (defaults to a pass). Select the failure mode with `failure_mode_index`. Overwrites any existing review for the same calls on this metric." } } } }, "/observability/v1/metric-failure-mode-insights/{id}/generate-scenario/": { "post": { "operationId": "metric-failure-mode-insights-generate-scenario-create", "description": "Turn one failure mode of a metric failure-mode insight into a test scenario that reproduces the issue against a target agent. Choose the failure mode with `failure_mode_index` and the agent with `agent`. Set `redact_transcripts` to strip personal identifiers from the source call transcripts before they are used to draft the scenario. Runs in the background and returns a `progress_id`; poll scenario generation progress to retrieve the generated scenario id.", "summary": "Generate a test scenario from an insight failure mode", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric failure mode insight.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsightGenerateScenario" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsightGenerateScenario" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsightGenerateScenario" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsightGenerateScenario" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-generate-scenario-create", "description": "Turn one failure mode of a metric failure-mode insight into a test scenario that reproduces the issue against a target agent. Choose the failure mode with `failure_mode_index` and the agent with `agent`. Set `redact_transcripts` to strip personal identifiers from the source call transcripts before they are used to draft the scenario. Runs in the background and returns a `progress_id`; poll scenario generation progress to retrieve the generated scenario id." } } } }, "/observability/v1/metric-failure-mode-insights/{id}/reproduce/": { "post": { "operationId": "metric-failure-mode-insights-reproduce-create", "description": "Draft a scenario from one failure mode and run it against the agent on the same channel the cited calls used, retrying until a run reproduces the failure or `max_attempts` is reached. Choose the failure mode with `failure_mode_index` and the target with `agent`. Returns a `reproduction_session_id`; poll the reproduction session for status. ⚠ Executes real evaluator runs against the agent.", "summary": "Reproduce a failure mode by running it against an agent", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric failure mode insight.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsightReproductionRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InsightReproductionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InsightReproductionRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsightReproductionRequest" } } }, "description": "" } }, "x-mcp-expose": true, "x-mcp-destructive": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-reproduce-create", "description": "Draft a scenario from one failure mode and run it against the agent on the same channel the cited calls used, retrying until a run reproduces the failure or `max_attempts` is reached. Choose the failure mode with `failure_mode_index` and the target with `agent`. Returns a `reproduction_session_id`; poll the reproduction session for status. ⚠ Executes real evaluator runs against the agent." } } } }, "/observability/v1/metric-failure-mode-insights/available_dates/": { "get": { "operationId": "metric-failure-mode-insights-available-dates-retrieve", "description": "Return the distinct calendar dates (newest first) on which the project has a completed failure-mode insight, so you can page back through historical daily insights via the `date` filter on list.", "summary": "List dates that have generated insights", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsight" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-available-dates-retrieve", "description": "Return the distinct calendar dates (newest first) on which the project has a completed failure-mode insight, so you can page back through historical daily insights via the `date` filter on list." } }, "parameters": [ { "name": "project", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `project` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ] } }, "/observability/v1/metric-failure-mode-insights/bulk_generate/": { "post": { "operationId": "metric-failure-mode-insights-bulk-generate-create", "description": "Queue a failure-mode audit for every eligible metric in the project over the last 24 hours and return the new insight rows to poll. Optionally restrict to specific metrics with `metric_names`. Metrics with no failing calls are skipped and not charged. ⚠ Consumes credits per metric that produces an insight — see the pricing endpoint.", "summary": "Generate failure-mode insights for every metric in a project", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsightBulkGenerate" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsightBulkGenerate" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsightBulkGenerate" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsightBulkGenerate" } } }, "description": "" } }, "x-mcp-expose": true, "x-mcp-destructive": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-bulk-generate-create", "description": "Queue a failure-mode audit for every eligible metric in the project over the last 24 hours and return the new insight rows to poll. Optionally restrict to specific metrics with `metric_names`. Metrics with no failing calls are skipped and not charged. ⚠ Consumes credits per metric that produces an insight — see the pricing endpoint." } } } }, "/observability/v1/metric-failure-mode-insights/categories/": { "get": { "operationId": "metric-failure-mode-insights-categories-retrieve", "description": "Return the persistent failure categories for a project (optionally one metric), each with a call count and example call ids. Filter by `date_from` / `date_to` (ISO datetimes for an exact window, or bare dates for whole-day bounds) to count only assignments in that range, and by `agent_ids` (comma-separated agent ids) to count only calls handled by those agents; results are sorted by count descending.", "summary": "List accumulating failure categories for a metric", "parameters": [ { "in": "query", "name": "agent_ids", "schema": { "type": "string" }, "description": "Comma-separated agent ids; only calls handled by these agents are counted." }, { "name": "project", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `project` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsight" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-categories-retrieve", "description": "Return the persistent failure categories for a project (optionally one metric), each with a call count and example call ids. Filter by `date_from` / `date_to` (ISO datetimes for an exact window, or bare dates for whole-day bounds) to count only assignments in that range, and by `agent_ids` (comma-separated agent ids) to count only calls handled by those agents; results are sorted by count descending." } } } }, "/observability/v1/metric-failure-mode-insights/categories/{category_slug}/calls/": { "get": { "operationId": "metric-failure-mode-insights-categories-calls-retrieve", "description": "Return all call-log ids assigned to one persistent failure category, newest first. Use the same date bounds as the category list to expand the examples shown for the selected range. The accumulator retains at most 500 calls per metric.", "summary": "List every call in one failure category", "parameters": [ { "in": "path", "name": "category_slug", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true }, { "in": "query", "name": "project", "schema": { "type": "integer" }, "required": true }, { "in": "query", "name": "metric_id", "schema": { "type": "integer" }, "required": true }, { "in": "query", "name": "date_from", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "date_to", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "agent_ids", "schema": { "type": "string" }, "description": "Comma-separated agent ids; only calls handled by these agents are returned." } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FailureCategoryCallsResponse" } } }, "description": "" } } } }, "/observability/v1/metric-failure-mode-insights/categories/{category_slug}/delete/": { "delete": { "operationId": "metric-failure-mode-insights-categories-delete-destroy", "description": "Remove one persistent failure category and all of its stored call assignments. Future calls are classified only against the remaining categories. Scope with `project` and `metric_id`. ⚠ Cannot be undone.", "summary": "Delete an accumulating failure category", "parameters": [ { "in": "path", "name": "category_slug", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } }, "x-mcp-expose": true, "x-mcp-destructive": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-categories-delete-destroy", "description": "Remove one persistent failure category and all of its stored call assignments. Future calls are classified only against the remaining categories. Scope with `project` and `metric_id`. ⚠ Cannot be undone." } } } }, "/observability/v1/metric-failure-mode-insights/categories/{category_slug}/fix-metric/": { "post": { "operationId": "metric-failure-mode-insights-categories-fix-metric-create", "description": "Sample the latest calls in one persistent failure category and add them to Labs for its metric, with `feedback` as the note and an optional corrected `expected_value` label (defaults to a pass).", "summary": "Add an accumulating failure category's example calls to Labs", "parameters": [ { "in": "path", "name": "category_slug", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeFixMetric" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricFailureModeFixMetric" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricFailureModeFixMetric" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeFixMetric" } } }, "description": "" } }, "x-mcp-expose": true, "x-mcp-destructive": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-categories-fix-metric-create", "description": "Sample the latest calls in one persistent failure category and add them to Labs for its metric, with `feedback` as the note and an optional corrected `expected_value` label (defaults to a pass)." } } } }, "/observability/v1/metric-failure-mode-insights/failure-rates/": { "get": { "operationId": "metric-failure-mode-insights-failure-rates-retrieve", "description": "Return the percentage of evaluated calls that failed each metric during the selected Insights date range. Optionally scope to `agent_ids` (comma-separated agent ids).", "summary": "List metric failure rates for the insights window", "parameters": [ { "in": "query", "name": "agent_ids", "schema": { "type": "string" }, "description": "Comma-separated agent ids; only calls handled by these agents are counted." } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsight" } } }, "description": "" } } } }, "/observability/v1/metric-failure-mode-insights/generate/": { "post": { "operationId": "metric-failure-mode-insights-generate-create", "description": "Queue a failure-mode audit of one metric's recent failing calls and return the new insight row in `pending`. Identify the metric with `metric_name` plus either `metric` (custom) or `predefined_metric`. Poll the returned row's `status` until it reaches `succeeded`. ⚠ Consumes credits per generated insight — see the pricing endpoint.", "summary": "Generate a failure-mode insight for one metric", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsightGenerate" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsightGenerate" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsightGenerate" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsightGenerate" } } }, "description": "" } }, "x-mcp-expose": true, "x-mcp-destructive": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-generate-create", "description": "Queue a failure-mode audit of one metric's recent failing calls and return the new insight row in `pending`. Identify the metric with `metric_name` plus either `metric` (custom) or `predefined_metric`. Poll the returned row's `status` until it reaches `succeeded`. ⚠ Consumes credits per generated insight — see the pricing endpoint." } } } }, "/observability/v1/metric-failure-mode-insights/pricing/": { "get": { "operationId": "metric-failure-mode-insights-pricing-retrieve", "description": "Return the per-metric credit cost of manually generating a metric failure-mode insight. Scope with `project`. Check this before `generate` or `bulk_generate` to know the charge.", "summary": "Get the credit cost of generating an insight", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricFailureModeInsight" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "metric-failure-mode-insights-pricing-retrieve", "description": "Return the per-metric credit cost of manually generating a metric failure-mode insight. Scope with `project`. Check this before `generate` or `bulk_generate` to know the charge." } }, "parameters": [ { "name": "project", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `project` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ] } }, "/observability/v1/observe/": { "post": { "operationId": "observe-create", "description": "Primary ingestion endpoint for production call logs. Your agent (or its provider's post-call webhook) POSTs here with the transcript, recording URL, and metadata; Cekura stores it as a `CallLog`, schedules metric evaluation, and surfaces it in Observability.\n\n**Identifying the agent (pick one):**\n- `agent` — Cekura agent ID (preferred when you've already registered via `POST /aiagents/`)\n- `assistant_id` — external assistant identifier (VAPI/Retell/OpenAI-style `asst_...`). Cekura resolves it to your agent.\n\n**Transcript formats** (via `transcript_type`):\n- `vapi`, `retell`, `elevenlabs`, `bland`, `livekit`, `pipecat`, `koreai` — provider-native shapes; pass `transcript_json` exactly as the provider emits it.\n- `cekura` (default) — `[{role, content, start_time, end_time}, ...]`. Valid roles: `\"Testing Agent\"` (the caller) and `\"Main Agent\"` (the agent under test). Note: `\"agent\"` and `\"user\"` are **not** valid for this format.\n\n**Provider-specific alternatives:**\n- LiveKit webhooks: `POST /observability/v1/livekit/observe/` (raw LiveKit webhook shape)\n- Pipecat webhooks: `POST /observability/v1/pipecat/observe/` (raw Pipecat webhook shape)\n\n**Fields to know:**\n- `voice_recording_url` — link to the call audio; enables audio-based metrics.\n- `metadata` — freeform tags for filtering in Observability (`customer_id`, `campaign_id`, etc.).\n- `dynamic_variables` — values injected into the agent at runtime; shown alongside the transcript.\n- `customer_number` — caller's number in E.164 format, e.g. `+14155551234`.\n- `call_ended_reason` — reason for call termination (`completed`, `user-hangup`, `agent-hangup`, etc.).\n- `metric_ids` — comma-separated metric IDs to evaluate immediately (e.g. `\"1,2,3\"`).\n\n**Async processing:** metrics are evaluated in the background. The initial response shows `status: \"evaluating\"` with an empty `metrics` list. Retrieve the call log again after 30–60 seconds to see completed metric results.\n\n**Billing:** each ingested call consumes observability credits. Calls with audio cost more than text-only calls. Check your balance via `GET /test_framework/v1/billing_info`.", "summary": "Ingest a production call (webhook)", "tags": [ "Observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCallLog" }, "examples": { "CreateCallLogWithVoiceRecordingURL": { "value": { "call_id": "call_12345678", "agent": 1, "voice_recording_url": "https://example.com/recordings/call_12345678.mp3", "transcript_type": "vapi", "transcript_json": [ { "role": "agent", "message": "Hello, how can I help you today?", "time": 0 }, { "role": "user", "message": "I need help with my account", "time": 2.5 } ], "call_ended_reason": "completed", "customer_number": "+1234567890", "metadata": { "customer_id": "cust_123", "campaign_id": "camp_456" }, "timestamp": "2025-10-03T10:30:00Z", "dynamic_variables": { "customer_name": "John Doe", "order_id": "ORD-12345" } }, "summary": "Create Call Log with Voice Recording URL" }, "CreateCallLogWithAssistantID": { "value": { "call_id": "call_87654321", "assistant_id": "asst_abc123", "voice_recording_url": "https://example.com/recordings/call_87654321.mp3", "transcript_type": "retell", "transcript_json": [ { "role": "agent", "message": "Thank you for calling. How may I assist you?", "time": 0 } ], "call_ended_reason": "user-hangup", "customer_number": "+9876543210" }, "summary": "Create Call Log with Assistant ID" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateCallLog" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateCallLog" } } }, "required": true }, "security": [ { "oauth2": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogList" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "observe-create", "description": "Primary ingestion endpoint for production call logs. Your agent (or its provider's post-call webhook) POSTs here with the transcript, recording URL, and metadata; Cekura stores it as a `CallLog`, schedules metric evaluation, and surfaces it in Observability.\n\n**Identifying the agent (pick one):**\n- `agent` — Cekura agent ID (preferred when you've already registered via `POST /aiagents/`)\n- `assistant_id` — external assistant identifier (VAPI/Retell/OpenAI-style `asst_...`). Cekura resolves it to your agent.\n\n**Transcript formats** (via `transcript_type`):\n- `vapi`, `retell`, `elevenlabs`, `bland`, `livekit`, `pipecat`, `koreai` — provider-native shapes; pass `transcript_json` exactly as the provider emits it.\n- `cekura` (default) — `[{role, content, start_time, end_time}, ...]`. Valid roles: `\"Testing Agent\"` (the caller) and `\"Main Agent\"` (the agent under test). Note: `\"agent\"` and `\"user\"` are **not** valid for this format.\n\n**Provider-specific alternatives:**\n- LiveKit webhooks: `POST /observability/v1/livekit/observe/` (raw LiveKit webhook shape)\n- Pipecat webhooks: `POST /observability/v1/pipecat/observe/` (raw Pipecat webhook shape)\n\n**Fields to know:**\n- `voice_recording_url` — link to the call audio; enables audio-based metrics.\n- `metadata` — freeform tags for filtering in Observability (`customer_id`, `campaign_id`, etc.).\n- `dynamic_variables` — values injected into the agent at runtime; shown alongside the transcript.\n- `customer_number` — caller's number in E.164 format, e.g. `+14155551234`.\n- `call_ended_reason` — reason for call termination (`completed`, `user-hangup`, `agent-hangup`, etc.).\n- `metric_ids` — comma-separated metric IDs to evaluate immediately (e.g. `\"1,2,3\"`).\n\n**Async processing:** metrics are evaluated in the background. The initial response shows `status: \"evaluating\"` with an empty `metrics` list. Retrieve the call log again after 30–60 seconds to see completed metric results.\n\n**Billing:** each ingested call consumes observability credits. Calls with audio cost more than text-only calls. Check your balance via `GET /test_framework/v1/billing_info`." } } } }, "/observability/v1/overall_evaluation/": { "get": { "operationId": "overall-evaluation-list", "description": "List overall evaluations", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OverallEvaluation" } } } }, "description": "" } } }, "post": { "operationId": "overall-evaluation-create", "description": "Create a new overall evaluation", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OverallEvaluation" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OverallEvaluation" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OverallEvaluation" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OverallEvaluation" } } }, "description": "" } } } }, "/observability/v1/overall_evaluation/{id}/": { "get": { "operationId": "overall-evaluation-retrieve", "description": "Retrieve an overall evaluation by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this overall evaluation.", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OverallEvaluation" } } }, "description": "" } } }, "put": { "operationId": "overall-evaluation-update", "description": "Update an overall evaluation", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this overall evaluation.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OverallEvaluation" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OverallEvaluation" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OverallEvaluation" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OverallEvaluation" } } }, "description": "" } } }, "patch": { "operationId": "overall-evaluation-partial-update", "description": "Update an overall evaluation", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this overall evaluation.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedOverallEvaluation" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedOverallEvaluation" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedOverallEvaluation" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OverallEvaluation" } } }, "description": "" } } }, "delete": { "operationId": "overall-evaluation-destroy", "description": "Delete an overall evaluation", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this overall evaluation.", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/observability/v1/overall_evaluation/generate_overall_summary/": { "get": { "operationId": "overall-evaluation-generate-overall-summary-retrieve", "description": "Overall evaluation generate overall summary", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OverallEvaluation" } } }, "description": "" } } } }, "/observability/v1/overall_evaluation/realtime/": { "get": { "operationId": "overall-evaluation-realtime-retrieve", "description": "Overall evaluation realtime", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "deprecated": true, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OverallEvaluation" } } }, "description": "" } } } }, "/observability/v1/pipecat/observe/": { "post": { "operationId": "pipecat-observe-create", "description": "Ingest a Pipecat post-call webhook.\n\nPoint your Pipecat / Daily.co deployment's post-session webhook at this URL. The raw\nwebhook body is stored as a CallLog and Cekura asynchronously pulls the transcript,\nrecording, and metrics from the configured egress location.\n\n**Use this instead of `POST /observability/v1/observe/`** when your agent runs on\nPipecat / Daily.co — you don't have to reformat the payload.", "tags": [ "observability" ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/observability/v1/retell/observe/": { "post": { "operationId": "retell-observe-create", "description": "Handle incoming Retell webhook requests.\n\nThis endpoint processes webhook requests from the Retell service, validates the request data,\nand creates a call log entry based on the received data. Retell sends webhooks at the end of the call,\nproviding important information about the interaction.", "tags": [ "observability" ], "responses": { "200": { "description": "No response body" } } } }, "/observability/v1/vapi/observe/": { "post": { "operationId": "vapi-observe-create", "description": "Handle incoming VAPI webhook requests.\n\nThis endpoint processes webhook requests from the VAPI service, validates the API key,\nand creates a call log entry based on the received data. VAPI sends webhooks at the end of the call,\nproviding important information about the interaction.", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/observability/v2/call-logs/": { "get": { "operationId": "observability-v2-call-logs-list", "description": "List **production** call logs for an agent or project. Production-only — test/simulation runs triggered via `run_scenarios_*` do NOT create call logs; use `results_list` + `runs_bulk_retrieve` for simulation data instead.\n\nAlways pass `agent_id` or `project_id` to scope results — without one, the response may be very large. **`project_id` is required when using an organization-level API key.**\n\n**Time window:** results default to the **last 30 days** when no timestamp range is given. A supplied range must not exceed **31 days** (wider ranges return `400`); pass `timestamp_from`/`timestamp_to` (ISO 8601) to select a window within that limit.\n\n**Filtering:**\n- `timestamp_from` / `timestamp_to` — ISO 8601 date range filter\n- `call_ids` — comma-separated **CallLog IDs** (integer DB IDs of call logs in this list response), e.g. `\"123,456\"`. Distinct from simulation `run_id`s and from each call log's own `call_id` field (which holds the provider's call identifier string).\n- `filters_v2` — structured JSON filter (same format as dashboard filters). Simple: `{\"field\": \"success\", \"op\": \"eq\", \"value\": true}`. Compound: `{\"operator\": \"and\", \"conditions\": [{...}, {...}]}`. Supported operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `startswith`, `in`, `isnull`.", "summary": "List call logs", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "timestamp_from", "schema": { "type": "string", "format": "date-time" }, "description": "\nFilter results from this timestamp (e.g. 2025-01-01T00:00:00Z)\nExample: `2025-01-01T00:00:00Z`\n" }, { "in": "query", "name": "timestamp_to", "schema": { "type": "string", "format": "date-time" }, "description": "\nFilter results to this timestamp (e.g. 2025-01-31T23:59:59Z)\nExample: `2025-01-31T23:59:59Z`\n" }, { "in": "query", "name": "call_ids", "schema": { "type": "string", "minLength": 1 }, "description": "Comma-separated list of call log IDs to filter by. Example: `\"5181749,5181752\"`" }, { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "\nFilter by agent ID. Either agent_id or project_id should be provided.\nExample: `2142`\n" }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "\nFilter by project ID. Either agent_id or project_id should be provided.\n**Required when using an organization-level API key** to scope results to a specific project.\nExample: `1376`\n" }, { "in": "query", "name": "assistant_id", "schema": { "type": "string", "minLength": 1 }, "description": "\nFilter by assistant ID\nExample:\n- `\"asst_1234567890\"`\n- `\"agent_xyz789\"`\n" }, { "in": "query", "name": "filters_v2", "schema": { "type": "string", "minLength": 1 }, "description": "\nAdvanced JSON filters using CallLogQueryFilter format (same as dashboard filters).\nSupports nested AND/OR conditions, field comparisons, and related field filtering.\n\nExample - Simple filter:\n`{\"field\": \"success\", \"op\": \"eq\", \"value\": true}`\n\nExample - AND conditions:\n`{\"operator\": \"and\", \"conditions\": [{\"field\": \"success\", \"op\": \"eq\", \"value\": true}, {\"field\": \"duration\", \"op\": \"gte\", \"value\": 60}]}`\n\nExample - OR conditions:\n`{\"operator\": \"or\", \"conditions\": [{\"field\": \"call_ended_reason\", \"op\": \"eq\", \"value\": \"completed\"}, {\"field\": \"call_ended_reason\", \"op\": \"eq\", \"value\": \"hangup\"}]}`\n\nSupported fields: success, duration, call_id, timestamp, created_at, call_ended_reason, customer_number, etc.\nSupported operators: eq, neq, gt, gte, lt, lte, contains, startswith, in, isnull\n" } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCallLogListList" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "observability-v2-call-logs-list", "description": "List **production** call logs for an agent or project. Production-only — test/simulation runs triggered via `run_scenarios_*` do NOT create call logs; use `results_list` + `runs_bulk_retrieve` for simulation data instead.\n\nAlways pass `agent_id` or `project_id` to scope results — without one, the response may be very large. **`project_id` is required when using an organization-level API key.**\n\n**Time window:** results default to the **last 30 days** when no timestamp range is given. A supplied range must not exceed **31 days** (wider ranges return `400`); pass `timestamp_from`/`timestamp_to` (ISO 8601) to select a window within that limit.\n\n**Filtering:**\n- `timestamp_from` / `timestamp_to` — ISO 8601 date range filter\n- `call_ids` — comma-separated **CallLog IDs** (integer DB IDs of call logs in this list response), e.g. `\"123,456\"`. Distinct from simulation `run_id`s and from each call log's own `call_id` field (which holds the provider's call identifier string).\n- `filters_v2` — structured JSON filter (same format as dashboard filters). Simple: `{\"field\": \"success\", \"op\": \"eq\", \"value\": true}`. Compound: `{\"operator\": \"and\", \"conditions\": [{...}, {...}]}`. Supported operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `startswith`, `in`, `isnull`." } } }, "post": { "operationId": "observability-v2-call-logs-create", "description": "Create a new Call logs with the canonical binary wire format (eval_type `binary`,", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v2/call-logs/{id}/": { "get": { "operationId": "observability-v2-call-logs-retrieve", "description": "Retrieve a production CallLog by its integer **CallLog ID** (path parameter). This is distinct from simulation `run_id` (use `runs_retrieve` for those) and from the call log's own `call_id` string field (the provider's call identifier).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Get a call log", "x-mint": { "mcp": { "enabled": true, "name": "observability-v2-call-logs-retrieve", "description": "Retrieve a production CallLog by its integer **CallLog ID** (path parameter). This is distinct from simulation `run_id` (use `runs_retrieve` for those) and from the call log's own `call_id` string field (the provider's call identifier)." } } }, "patch": { "operationId": "observability-v2-call-logs-partial-update_3", "description": "Updates source data for an existing production call log.\n\n**Supported fields**\n- `call_id` — Provider call identifier. Subject to the organization's duplicate-call-ID policy.\n- `transcript_json` — Structured transcript in a supported provider or Cekura format. Use `transcript_type` to specify the format, or omit it for automatic detection. This replaces both transcript representations.\n- `timestamp` — Call start time in ISO 8601 format.\n- `duration` — Call duration in minutes.\n- `call_ended_reason` and `customer_number` — Provider-supplied call attributes.\n- `metadata` and `dynamic_variables` — JSON objects merged at the top level with the existing values. Supplied keys overwrite matching keys; omitted keys are preserved.\n\n**Restrictions**\nOnly the fields listed above are accepted. System-managed fields, including agent and project ownership, metric evaluations, review state, topic, and dropoff point, cannot be updated.\n\n**Metric evaluation**\nThis operation does not recompute metrics. To evaluate the updated call data, invoke `rerun_evaluation` in a separate request.", "summary": "Update call log source data", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedUpdateCallLog" }, "examples": { "Append-twilio-insights": { "value": { "metadata": { "twilio_insights": { "call_sid": "CA123", "answered_by": "human" } } }, "summary": "Append Twilio Insights metadata" }, "Correct-source-call-data": { "value": { "call_id": "provider-call-123", "duration": 1.5, "call_ended_reason": "customer-ended-call" }, "summary": "Correct provider-supplied call data" }, "Update-structured-transcript": { "value": { "transcript_type": "cekura", "transcript_json": [ { "role": "Testing Agent", "content": "Hello.", "start_time": 0, "end_time": 1 }, { "role": "Main Agent", "content": "How can I help?", "start_time": 1, "end_time": 2.5 } ] }, "summary": "Update a structured transcript" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedUpdateCallLog" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedUpdateCallLog" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "observability-v2-call-logs-partial-update", "description": "Updates source data for an existing production call log.\n\n**Supported fields**\n- `call_id` — Provider call identifier. Subject to the organization's duplicate-call-ID policy.\n- `transcript_json` — Structured transcript in a supported provider or Cekura format. Use `transcript_type` to specify the format, or omit it for automatic detection. This replaces both transcript representations.\n- `timestamp` — Call start time in ISO 8601 format.\n- `duration` — Call duration in minutes.\n- `call_ended_reason` and `customer_number` — Provider-supplied call attributes.\n- `metadata` and `dynamic_variables` — JSON objects merged at the top level with the existing values. Supplied keys overwrite matching keys; omitted keys are preserved.\n\n**Restrictions**\nOnly the fields listed above are accepted. System-managed fields, including agent and project ownership, metric evaluations, review state, topic, and dropoff point, cannot be updated.\n\n**Metric evaluation**\nThis operation does not recompute metrics. To evaluate the updated call data, invoke `rerun_evaluation` in a separate request." } } }, "delete": { "operationId": "observability-v2-call-logs-destroy", "description": "⚠ Irreversible. Deletes the call log along with its transcript and voice recording. By default metric evaluations are also deleted; set `retain_evaluations=true` to keep them and leave the call record un-soft-deleted.", "summary": "Delete a call log", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true }, { "in": "query", "name": "retain_evaluations", "schema": { "type": "boolean", "default": false }, "description": "If true, metric evaluations are retained and the call log is not soft-deleted. Default: false." } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "observability-v2-call-logs-destroy", "description": "⚠ Irreversible. Deletes the call log along with its transcript and voice recording. By default metric evaluations are also deleted; set `retain_evaluations=true` to keep them and leave the call record un-soft-deleted." } } } }, "/observability/v2/call-logs/{id}/mark_critical_scenario_wrong/": { "post": { "operationId": "observability-v2-call-logs-mark-critical-scenario-wrong-create", "description": "Observability v2 call logs mark critical scenario wrong", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v2/call-logs/{id}/mark_metric_vote/": { "post": { "operationId": "observability-v2-call-logs-mark-metric-vote-create", "description": "Record a thumbs-up or thumbs-down vote on a specific metric evaluation for this call log and optionally provide an expected value and free-text feedback. Updates the metric evaluation and marks the call log as reviewed.", "summary": "Submit a metric vote for a call log", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "Call Logs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkMetricVoteCallLogResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "observability-v2-call-logs-mark-metric-vote-create", "description": "Record a thumbs-up or thumbs-down vote on a specific metric evaluation for this call log and optionally provide an expected value and free-text feedback. Updates the metric evaluation and marks the call log as reviewed." } } } }, "/observability/v2/call-logs/{id}/unmark_critical_scenario_wrong/": { "post": { "operationId": "observability-v2-call-logs-unmark-critical-scenario-wrong-create", "description": "Observability v2 call logs unmark critical scenario wrong", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this call log.", "required": true } ], "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v2/call-logs/analyze_call_logs/": { "get": { "operationId": "observability-v2-call-logs-analyze-call-logs-retrieve", "description": "Analyze call logs using Claude Agent SDK.\n\nClaude uses Read/Bash tools to query the CSV file without loading it into context.\nThis allows analyzing large datasets efficiently.", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v2/call-logs/complete-upload/": { "post": { "operationId": "observability-v2-call-logs-complete-upload-create", "description": "Observability v2 call logs complete upload", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v2/call-logs/create_scenarios/": { "post": { "operationId": "call-logs-create-scenarios_3", "description": "Generate test scenarios from real production call logs.\n\nReturns a `progress_id` immediately — the actual scenario creation runs in the background.\nPoll `GET /observability/v1/call-logs/create_scenarios_progress?progress_id=` until\n`completed_scenarios + failed_scenarios >= total_scenarios`. The `scenarios_list` field\n(full Scenario objects) is populated only once processing is complete.\n\n**`call_logs` accepts:** a list of IDs `[1, 2, 3]` or `\"all\"` for every call log on the agent.\n\n**`copy_to_agent`:** optionally copy the generated scenarios to a different agent —\nuseful when your observation agent and your test agent are separate.\n\n**Prerequisite:** call logs must have a transcript (uploaded via `transcript_json`).\nAudio-only logs without a transcript cannot produce scenarios.", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateScenarios" }, "examples": { "Create-scenarios-with-agent-id": { "value": { "agent_id": 2142, "call_logs": [ 1, 2, 3 ], "copy_to_agent": null }, "summary": "create-scenarios-with-agent-id" }, "Create-scenarios-with-assistant-id": { "value": { "assistant_id": "asst_1234567890", "call_logs": "all" }, "summary": "create-scenarios-with-assistant-id" }, "Create-scenarios-with-copy-to-agent": { "value": { "agent_id": 2142, "call_logs": [ 1, 2, 3 ], "copy_to_agent": 2143 }, "summary": "create-scenarios-with-copy-to-agent" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateScenarios" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateScenarios" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "progress_id": { "type": "string", "format": "uuid", "description": "Unique identifier for tracking the progress of scenario creation" } } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" }, "403": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Create scenarios from call logs", "x-mint": { "mcp": { "enabled": true, "name": "call-logs-create-scenarios", "description": "Generate test scenarios from real production call logs.\n\nReturns a `progress_id` immediately — the actual scenario creation runs in the background.\nPoll `GET /observability/v1/call-logs/create_scenarios_progress?progress_id=` until\n`completed_scenarios + failed_scenarios >= total_scenarios`. The `scenarios_list` field\n(full Scenario objects) is populated only once processing is complete.\n\n**`call_logs` accepts:** a list of IDs `[1, 2, 3]` or `\"all\"` for every call log on the agent.\n\n**`copy_to_agent`:** optionally copy the generated scenarios to a different agent —\nuseful when your observation agent and your test agent are separate.\n\n**Prerequisite:** call logs must have a transcript (uploaded via `transcript_json`).\nAudio-only logs without a transcript cannot produce scenarios." } } } }, "/observability/v2/call-logs/create_scenarios_progress/": { "get": { "operationId": "call-logs-create-scenarios-progress_3", "description": "Get scenarios-from-call-logs progress", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string", "format": "uuid" }, "description": "Progress ID returned from create_scenarios endpoint", "required": true }, { "name": "agent_id", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `agent_id`, `project_id` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." }, { "name": "project_id", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `agent_id`, `project_id` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ], "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaCreateScenariosProgressResponse" }, "examples": { "Progress-in-progress": { "value": { "agent_id": 2142, "completed_scenarios": 2, "failed_scenarios": 0, "total_scenarios": 5, "scenarios_list": [], "errors": [] }, "summary": "progress-in-progress" }, "Progress-completed": { "value": { "agent_id": 2142, "completed_scenarios": 4, "failed_scenarios": 1, "total_scenarios": 5, "scenarios_list": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier for the scenario" }, "name": { "type": "string", "description": "Name of the scenario" }, "agent": { "type": "integer", "description": "ID of the AI agent this scenario belongs to" }, "assistant_id": { "type": "string", "description": "Alternative to agent ID - the assistant ID to use for this scenario" }, "personality": { "type": "integer", "description": "ID of the personality used in this scenario" }, "personality_name": { "type": "string", "description": "Name of the personality used in this scenario" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags associated with this scenario." }, "runs": { "type": "array", "items": { "type": "integer" }, "description": "List of IDs for the last run of this scenario" }, "metrics": { "type": "array", "items": { "type": "integer" }, "description": "List of metric IDs to associate with this scenario" }, "metric_names": { "type": "array", "items": { "type": "string" }, "description": "List of metric names associated with this scenario" }, "phone_number": { "type": "string", "description": "Phone number used for outbound calls in this scenario" }, "phone_number_queue_length": { "type": "integer", "description": "Number of runs in queue for this phone number" }, "first_message": { "type": "string", "description": "First message to be sent in the scenario" }, "inbound_phone_number": { "type": "integer", "description": "ID of the phone number used for inbound calls" }, "inbound_phone_number_data": { "type": "object", "description": "Details of the phone number used for inbound calls", "properties": { "id": { "type": "integer", "description": "ID of the inbound phone number" }, "number": { "type": "string", "description": "The actual phone number" }, "phone_number_id": { "type": "string", "description": "External ID of the phone number" } } }, "instructions": { "type": "string", "description": "Instructions for the AI agent in this scenario" }, "simulation_description": { "type": "string", "description": "Description of the simulation if this scenario was created by simulation" }, "information_fields": { "type": "object", "description": "Additional information fields for the scenario" }, "expected_outcome_prompt": { "type": "string", "description": "Expected outcome prompt for the scenario" }, "scenario_language": { "type": "string", "description": "Language of the scenario" }, "is_simulating": { "type": "boolean", "description": "Whether this scenario was created by simulation" }, "test_profile_data": { "type": "object", "description": "The test profile generated for this scenario, including its sectioned `information` (main_agent_variables / testing_agent_variables)" }, "generated_mock_tool_entries": { "type": "array", "description": "Expected mock tool calls generated for this scenario when the agent has mock tools attached. Empty when the agent has no mock tools.", "items": { "type": "object", "properties": { "tool_id": { "type": "integer", "description": "ID of the mock tool on the agent" }, "tool_name": { "type": "string", "description": "Name of the tool being mocked" }, "new_entry": { "type": "object", "description": "The expected tool call for this scenario", "properties": { "input": { "type": "object", "description": "Input parameters the tool call is expected to receive" }, "output": { "type": "object", "description": "Response the mock tool will return" } } } } } } } } }, "errors": [ { "call_log_id": 3, "error": { "detail": "Transcript is missing" } } ] }, "summary": "progress-completed" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Get scenarios-from-call-logs progress", "x-mint": { "mcp": { "enabled": true, "name": "call-logs-create-scenarios-progress", "description": "Get scenarios-from-call-logs progress" } } } }, "/observability/v2/call-logs/delete_call_logs/": { "post": { "operationId": "call-logs-bulk-delete_3", "description": "Call logs bulk delete", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCallLogs" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DeleteCallLogs" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DeleteCallLogs" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/observability/v2/call-logs/evaluate_metrics/": { "post": { "operationId": "observability-v2-call-logs-evaluate-metrics-create", "description": "Evaluate one or more metrics against selected call logs. Unlike `rerun_evaluation` (which re-runs all assigned metrics), this endpoint lets you target specific metrics.\n\n**Scope:** provide either `agent_id` or `project_id` to identify which agent's call logs and metrics to use. Metrics must belong to the specified agent or project.\n\n**Credit check:** cost scales with the number of call logs and metrics selected. The request is rejected if your balance is insufficient — check your balance first via `test_framework_billing_info_retrieve`.\n\n**Async:** evaluation runs in the background. The response returns the call logs in their current state. Retrieve each call log individually to see updated metric results once evaluation completes.\n\n**Rate limited.** Respect 429 responses — wait for the `Retry-After` duration.", "summary": "Run specific metrics against call logs", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateMetrics" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EvaluateMetrics" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/EvaluateMetrics" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallLogList" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "observability-v2-call-logs-evaluate-metrics-create", "description": "Evaluate one or more metrics against selected call logs. Unlike `rerun_evaluation` (which re-runs all assigned metrics), this endpoint lets you target specific metrics.\n\n**Scope:** provide either `agent_id` or `project_id` to identify which agent's call logs and metrics to use. Metrics must belong to the specified agent or project.\n\n**Credit check:** cost scales with the number of call logs and metrics selected. The request is rejected if your balance is insufficient — check your balance first via `test_framework_billing_info_retrieve`.\n\n**Async:** evaluation runs in the background. The response returns the call logs in their current state. Retrieve each call log individually to see updated metric results once evaluation completes.\n\n**Rate limited.** Respect 429 responses — wait for the `Retry-After` duration." } } } }, "/observability/v2/call-logs/export_call_logs/": { "get": { "operationId": "observability-v2-call-logs-export-call-logs-retrieve", "description": "Observability v2 call logs export call logs", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v2/call-logs/export_call_logs_progress/": { "get": { "operationId": "observability-v2-call-logs-export-call-logs-progress-retrieve", "description": "Observability v2 call logs export call logs progress", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v2/call-logs/filters/": { "get": { "operationId": "observability-v2-call-logs-filters-retrieve", "description": "Observability v2 call logs filters", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v2/call-logs/filters_call_id/": { "get": { "operationId": "observability-v2-call-logs-filters-call-id-retrieve", "description": "Autocomplete-search the production CallLog `call_id` field (the provider's call identifier string). This is distinct from simulation `run_id` (integer; see `runs_list`) and from CallLog ID (integer DB ID).", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v2/call-logs/filters_customer_number/": { "get": { "operationId": "observability-v2-call-logs-filters-customer-number-retrieve", "description": "Observability v2 call logs filters customer number", "tags": [ "observability" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v2/call-logs/get-upload-url/": { "post": { "operationId": "observability-v2-call-logs-get-upload-url-create", "description": "Observability v2 call logs get upload url", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDetail" } } }, "description": "" } } } }, "/observability/v2/call-logs/rerun_evaluation/": { "post": { "operationId": "observability-v2-call-logs-rerun-evaluation-create", "description": "Trigger metric re-evaluation on one or more existing call logs. Provide either `agent_id` or `assistant_id` (not both) to identify the agent, then specify which call logs to re-evaluate.\n\n**`call_logs` accepts:**\n- A list of call log IDs: `[1, 2, 3]`\n- The string `\"all\"` to re-evaluate every call log for the agent\n\n**Side effect:** for non-reviewed call logs, `success` is reset to `null` before re-evaluation begins. Reviewed call logs retain their human-approved outcome.\n\n**Rate limited.** If the limit is exceeded you will receive a 429 response — wait for the `Retry-After` duration before retrying.", "summary": "Re-run metric evaluation on call logs", "tags": [ "observability" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RerunEvaluation" }, "examples": { "Re-evaluate-specific-call-logs": { "value": { "agent_id": 2142, "call_logs": [ 101, 102, 103 ] }, "summary": "re-evaluate-specific-call-logs" }, "Re-evaluate-all-call-logs": { "value": { "agent_id": 2142, "call_logs": "all" }, "summary": "re-evaluate-all-call-logs" }, "Re-evaluate-using-assistant-id": { "value": { "assistant_id": 2143, "call_logs": [ 101, 102 ] }, "summary": "re-evaluate-using-assistant-id" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RerunEvaluation" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RerunEvaluation" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallLogDetail" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "observability-v2-call-logs-rerun-evaluation-create", "description": "Trigger metric re-evaluation on one or more existing call logs. Provide either `agent_id` or `assistant_id` (not both) to identify the agent, then specify which call logs to re-evaluate.\n\n**`call_logs` accepts:**\n- A list of call log IDs: `[1, 2, 3]`\n- The string `\"all\"` to re-evaluate every call log for the agent\n\n**Side effect:** for non-reviewed call logs, `success` is reset to `null` before re-evaluation begins. Reviewed call logs retain their human-approved outcome.\n\n**Rate limited.** If the limit is exceeded you will receive a 429 response — wait for the `Retry-After` duration before retrying." } } } }, "/schedules/v1/cron-jobs/": { "get": { "operationId": "cron-jobs-list", "description": "List all scheduled jobs", "parameters": [ { "in": "query", "name": "agent_id", "schema": { "type": "string" }, "description": "\nFilter by agent id\nExample: `123`\n" }, { "in": "query", "name": "project_id", "schema": { "type": "string" }, "description": "\nFilter by project id\nExample: `123`\n" }, { "name": "organization_id", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `agent_id`, `project_id`, `organization_id` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ], "tags": [ "schedules" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CronJob" } } } }, "description": "" } }, "x-mcp-expose": true, "summary": "List scheduled jobs", "x-mint": { "mcp": { "enabled": true, "name": "cron-jobs-list", "description": "List all scheduled jobs" } } }, "post": { "operationId": "cron-jobs-create", "description": "Create a cron job that runs evaluators against your agent on a recurring schedule (daily regression tests, hourly smoke tests, weekly rollups, etc.). The job invokes the same logic as `run_scenarios` but on a timer.\n\n**Scenario selection (pick one):**\n- `scenarios` — explicit list of evaluator IDs\n- `tags` — run every evaluator matching these tags\n\n**Execution mode** (`execution_mode`) — defaults to voice; also supports `text`, `sip`, etc. Matches the corresponding `run_scenarios` / `run_scenarios_text` endpoint.\n\n**Schedule:** `crontab_expression` uses standard cron syntax (`minute hour day month day-of-week`). Combine with `timezone` (IANA name, e.g. `America/New_York`) to control when the job fires.\n\n**Run size:** `frequency` multiplies each scenario. Personality / test-profile overrides behave identically to `run_scenarios` — same billing rules apply.", "summary": "Schedule a recurring evaluator run", "tags": [ "Schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostCronJob" }, "examples": { "CreateScheduledJobWithScenarios": { "value": { "name": "Daily Agent Test", "scenarios": [ 1, 2, 3 ], "agent": 1, "crontab_expression": "0 9 * * 1-5", "timezone": "America/New_York" }, "summary": "Create Scheduled Job with Scenarios" }, "CreateScheduledJobWithTags": { "value": { "name": "Weekly Regression Test", "tags": [ "regression", "high-priority" ], "agent": 1, "crontab_expression": "0 0 * * 0", "timezone": "UTC" }, "summary": "Create Scheduled Job with Tags" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostCronJob" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostCronJob" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CronJob" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "cron-jobs-create", "description": "Create a cron job that runs evaluators against your agent on a recurring schedule (daily regression tests, hourly smoke tests, weekly rollups, etc.). The job invokes the same logic as `run_scenarios` but on a timer.\n\n**Scenario selection (pick one):**\n- `scenarios` — explicit list of evaluator IDs\n- `tags` — run every evaluator matching these tags\n\n**Execution mode** (`execution_mode`) — defaults to voice; also supports `text`, `sip`, etc. Matches the corresponding `run_scenarios` / `run_scenarios_text` endpoint.\n\n**Schedule:** `crontab_expression` uses standard cron syntax (`minute hour day month day-of-week`). Combine with `timezone` (IANA name, e.g. `America/New_York`) to control when the job fires.\n\n**Run size:** `frequency` multiplies each scenario. Personality / test-profile overrides behave identically to `run_scenarios` — same billing rules apply." } } } }, "/schedules/v1/cron-jobs-external/": { "get": { "operationId": "cron-jobs-external-list", "description": "List all scheduled jobs", "parameters": [ { "in": "query", "name": "agent_id", "schema": { "type": "string" }, "description": "\nFilter by agent id\nExample: `123`\n" }, { "in": "query", "name": "project_id", "schema": { "type": "string" }, "description": "\nFilter by project id\nExample: `123`\n" } ], "tags": [ "schedules" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CronJob" } } } }, "description": "" } } }, "post": { "operationId": "cron-jobs-external-create", "description": "Create a cron job that runs evaluators against your agent on a recurring schedule (daily regression tests, hourly smoke tests, weekly rollups, etc.). The job invokes the same logic as `run_scenarios` but on a timer.\n\n**Scenario selection (pick one):**\n- `scenarios` — explicit list of evaluator IDs\n- `tags` — run every evaluator matching these tags\n\n**Execution mode** (`execution_mode`) — defaults to voice; also supports `text`, `sip`, etc. Matches the corresponding `run_scenarios` / `run_scenarios_text` endpoint.\n\n**Schedule:** `crontab_expression` uses standard cron syntax (`minute hour day month day-of-week`). Combine with `timezone` (IANA name, e.g. `America/New_York`) to control when the job fires.\n\n**Run size:** `frequency` multiplies each scenario. Personality / test-profile overrides behave identically to `run_scenarios` — same billing rules apply.", "summary": "Schedule a recurring evaluator run", "tags": [ "Schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostCronJob" }, "examples": { "CreateScheduledJobWithScenarios": { "value": { "name": "Daily Agent Test", "scenarios": [ 1, 2, 3 ], "agent": 1, "crontab_expression": "0 9 * * 1-5", "timezone": "America/New_York" }, "summary": "Create Scheduled Job with Scenarios" }, "CreateScheduledJobWithTags": { "value": { "name": "Weekly Regression Test", "tags": [ "regression", "high-priority" ], "agent": 1, "crontab_expression": "0 0 * * 0", "timezone": "UTC" }, "summary": "Create Scheduled Job with Tags" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostCronJob" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostCronJob" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CronJob" } } }, "description": "" } } } }, "/schedules/v1/cron-jobs-external/{id}/": { "get": { "operationId": "cron-jobs-external-retrieve", "description": "Retrieve a scheduled job by id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cron job.", "required": true } ], "tags": [ "schedules" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CronJob" } } }, "description": "" } } }, "put": { "operationId": "cron-jobs-external-update", "description": "Update an existing scheduled job", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cron job.", "required": true } ], "tags": [ "schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostCronJob" }, "examples": { "UpdateScheduledJob": { "value": { "name": "Updated Daily Agent Test", "scenarios": [ 1, 2, 3, 4 ], "agent": 1, "crontab_expression": "0 10 * * 1-5", "timezone": "America/Los_Angeles" }, "summary": "Update Scheduled Job" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostCronJob" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostCronJob" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CronJob" } } }, "description": "" } } }, "patch": { "operationId": "cron-jobs-external-partial-update", "description": "Partially update an existing scheduled job", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cron job.", "required": true } ], "tags": [ "schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostCronJob" }, "examples": { "UpdateScheduleTimeOnly": { "value": { "crontab_expression": "0 8 * * 1-5" }, "summary": "Update Schedule Time Only" }, "UpdateScenariosOnly": { "value": { "scenarios": [ 5, 6, 7 ] }, "summary": "Update Scenarios Only" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostCronJob" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostCronJob" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CronJob" } } }, "description": "" } } }, "delete": { "operationId": "cron-jobs-external-destroy", "description": "⚠ Irreversible. Deletes the cron job and stops it from scheduling new runs. Past results from previous runs are retained.", "summary": "Delete a scheduled job", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cron job.", "required": true } ], "tags": [ "schedules" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "404": { "description": "No response body" } } } }, "/schedules/v1/cron-jobs/{id}/": { "get": { "operationId": "cron-jobs-retrieve", "description": "Retrieve a scheduled job by id", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cron job.", "required": true } ], "tags": [ "schedules" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CronJob" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Get a scheduled job", "x-mint": { "mcp": { "enabled": true, "name": "cron-jobs-retrieve", "description": "Retrieve a scheduled job by id" } } }, "put": { "operationId": "cron-jobs-update", "description": "Update an existing scheduled job", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cron job.", "required": true } ], "tags": [ "schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostCronJob" }, "examples": { "UpdateScheduledJob": { "value": { "name": "Updated Daily Agent Test", "scenarios": [ 1, 2, 3, 4 ], "agent": 1, "crontab_expression": "0 10 * * 1-5", "timezone": "America/Los_Angeles" }, "summary": "Update Scheduled Job" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostCronJob" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostCronJob" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CronJob" } } }, "description": "" } } }, "patch": { "operationId": "cron-jobs-partial-update", "description": "Partially update an existing scheduled job", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cron job.", "required": true } ], "tags": [ "schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostCronJob" }, "examples": { "UpdateScheduleTimeOnly": { "value": { "crontab_expression": "0 8 * * 1-5" }, "summary": "Update Schedule Time Only" }, "UpdateScenariosOnly": { "value": { "scenarios": [ 5, 6, 7 ] }, "summary": "Update Scenarios Only" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostCronJob" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostCronJob" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CronJob" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Update a scheduled job", "x-mint": { "mcp": { "enabled": true, "name": "cron-jobs-partial-update", "description": "Partially update an existing scheduled job" } } }, "delete": { "operationId": "cron-jobs-destroy", "description": "⚠ Irreversible. Deletes the cron job and stops it from scheduling new runs. Past results from previous runs are retained.", "summary": "Delete a scheduled job", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cron job.", "required": true } ], "tags": [ "schedules" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "404": { "description": "No response body" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "cron-jobs-destroy", "description": "⚠ Irreversible. Deletes the cron job and stops it from scheduling new runs. Past results from previous runs are retained." } } } }, "/schedules/v1/metric-optimiser-cron-jobs/": { "get": { "operationId": "metric-optimiser-cron-jobs-list", "description": "List all scheduled metric-optimiser jobs.", "parameters": [ { "in": "query", "name": "project_id", "schema": { "type": "string" } }, { "in": "query", "name": "organization_id", "schema": { "type": "string" } } ], "tags": [ "schedules" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetricOptimiserCronJob" } } } }, "description": "" } } }, "post": { "operationId": "metric-optimiser-cron-jobs-create", "description": "Create a cron job that runs the Metric Lab optimiser against one or more metrics on a recurring schedule. The optimiser uses every test set already in each metric's Lab (every MetricReview row). Set `auto_apply` to overwrite the live metric prompt when the optimised score is at least as good as the baseline on the labelled set — otherwise the run is read-only and emails a diff summary.", "summary": "Schedule a recurring metric optimiser run", "tags": [ "schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricOptimiserCronJob" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricOptimiserCronJob" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricOptimiserCronJob" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricOptimiserCronJob" } } }, "description": "" } } } }, "/schedules/v1/metric-optimiser-cron-jobs/{id}/": { "get": { "operationId": "metric-optimiser-cron-jobs-retrieve", "description": "Retrieve a scheduled metric-optimiser job by id.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric optimiser cron job.", "required": true } ], "tags": [ "schedules" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricOptimiserCronJob" } } }, "description": "" } } }, "put": { "operationId": "metric-optimiser-cron-jobs-update", "description": "Update an existing scheduled metric-optimiser job.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric optimiser cron job.", "required": true } ], "tags": [ "schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricOptimiserCronJob" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricOptimiserCronJob" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricOptimiserCronJob" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricOptimiserCronJob" } } }, "description": "" } } }, "patch": { "operationId": "metric-optimiser-cron-jobs-partial-update", "description": "Partially update an existing scheduled metric-optimiser job.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric optimiser cron job.", "required": true } ], "tags": [ "schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedMetricOptimiserCronJob" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedMetricOptimiserCronJob" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedMetricOptimiserCronJob" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricOptimiserCronJob" } } }, "description": "" } } }, "delete": { "operationId": "metric-optimiser-cron-jobs-destroy", "description": "Irreversible. Deletes the cron job and stops it from firing. Past optimiser runs are retained.", "summary": "Delete a scheduled metric-optimiser job", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric optimiser cron job.", "required": true } ], "tags": [ "schedules" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "404": { "description": "No response body" } } } }, "/slack/events/": { "post": { "operationId": "slack-events-create", "description": "Handle Slack interactive component callbacks", "tags": [ "slack" ], "responses": { "200": { "description": "No response body" } } } }, "/slack/interact/": { "post": { "operationId": "slack-interact-create", "description": "Handle Slack interactive component callbacks", "tags": [ "slack" ], "responses": { "200": { "description": "No response body" } } } }, "/slack/oauth/": { "post": { "operationId": "slack-oauth-create", "tags": [ "slack" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } }, "description": "Create a new slack oauth" } }, "/slack/slack-workspaces/": { "get": { "operationId": "slack-slack-workspaces-list", "description": "Return every Slack workspace connected to the project, with the bot's default `channel_id`, `team_name`, and verification status. Use to pick a `workspace_id` (and optionally a different `channel_id`) for the `notifications.slack` block on `alerts_create`. Access tokens and bot IDs are not returned.", "summary": "List Slack workspaces configured for a project", "tags": [ "slack" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SlackWorkspace" } } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "slack-slack-workspaces-list", "description": "Return every Slack workspace connected to the project, with the bot's default `channel_id`, `team_name`, and verification status. Use to pick a `workspace_id` (and optionally a different `channel_id`) for the `notifications.slack` block on `alerts_create`. Access tokens and bot IDs are not returned." } }, "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `project_id` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ] } }, "/slack/slack-workspaces/{id}/": { "get": { "operationId": "slack-slack-workspaces-retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this slack workspace.", "required": true } ], "tags": [ "slack" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackWorkspace" } } }, "description": "" } }, "description": "Retrieve a slack slack workspace by ID" }, "put": { "operationId": "slack-slack-workspaces-update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this slack workspace.", "required": true } ], "tags": [ "slack" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackWorkspace" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SlackWorkspace" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SlackWorkspace" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackWorkspace" } } }, "description": "" } }, "description": "Update a slack slack workspace" }, "patch": { "operationId": "slack-slack-workspaces-partial-update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this slack workspace.", "required": true } ], "tags": [ "slack" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSlackWorkspace" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedSlackWorkspace" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedSlackWorkspace" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackWorkspace" } } }, "description": "" } }, "description": "Update a slack slack workspace" }, "delete": { "operationId": "slack-slack-workspaces-destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this slack workspace.", "required": true } ], "tags": [ "slack" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "204": { "description": "No response body" } }, "description": "Delete a slack slack workspace" } }, "/slack/slack-workspaces/{id}/get_channels/": { "get": { "operationId": "slack-slack-workspaces-get-channels-retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this slack workspace.", "required": true } ], "tags": [ "slack" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackWorkspace" } } }, "description": "" } }, "description": "Slack slack workspaces get channels" } }, "/slack/slack-workspaces/{id}/members/": { "get": { "operationId": "slack-slack-workspaces-members-retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this slack workspace.", "required": true } ], "tags": [ "slack" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackWorkspace" } } }, "description": "" } }, "description": "Slack slack workspaces members" } }, "/slack/slack-workspaces/{id}/verify/": { "get": { "operationId": "slack-slack-workspaces-verify-retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this slack workspace.", "required": true } ], "tags": [ "slack" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackWorkspace" } } }, "description": "" } }, "description": "Slack slack workspaces verify" } }, "/subscriptions/create-checkout-session/": { "post": { "operationId": "subscriptions-create-checkout-session-create", "tags": [ "subscriptions" ], "security": [ { "supabase_session_inactive_allowed": [] } ], "responses": { "200": { "description": "No response body" } }, "description": "Create a new subscriptions create checkout session" } }, "/subscriptions/hackathon-pack/": { "post": { "operationId": "subscriptions-hackathon-pack-create", "description": "Grant hackathon pack access to organization.", "tags": [ "subscriptions" ], "security": [ { "supabase_session_inactive_allowed": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/subscriptions/pack-access-requests/": { "post": { "operationId": "subscriptions-pack-access-requests-create", "description": "Create new pack access request", "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackAccessRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PackAccessRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PackAccessRequest" } } }, "required": true }, "security": [ { "supabase_session_inactive_allowed": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackAccessRequest" } } }, "description": "" } } } }, "/subscriptions/packs/": { "get": { "operationId": "subscriptions-packs-list", "tags": [ "subscriptions" ], "security": [ { "supabase_session_inactive_allowed": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Pack" } } } }, "description": "" } }, "description": "List subscriptions packs" } }, "/subscriptions/packs/{id}/": { "get": { "operationId": "subscriptions-packs-retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this pack.", "required": true } ], "tags": [ "subscriptions" ], "security": [ { "supabase_session_inactive_allowed": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pack" } } }, "description": "" } }, "description": "Retrieve a subscriptions pack by ID" } }, "/subscriptions/packs/add_developer_pack/": { "post": { "operationId": "subscriptions-packs-add-developer-pack-create", "description": "Add developer pack to organization.\nPhone verification is not required here — it is only enforced\nfor the developer trial pack (add_developer_trial_pack).\nThrottled to 1 request per 30 seconds per user.", "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pack" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Pack" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Pack" } } }, "required": true }, "security": [ { "supabase_session_inactive_allowed": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pack" } } }, "description": "" } } } }, "/subscriptions/packs/add_developer_trial_pack/": { "post": { "operationId": "subscriptions-packs-add-developer-trial-pack-create", "description": "Add self-serve trial pack to organization after verifying phone number.", "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pack" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Pack" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Pack" } } }, "required": true }, "security": [ { "supabase_session_inactive_allowed": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pack" } } }, "description": "" } } } }, "/subscriptions/packs/add_pack/": { "post": { "operationId": "subscriptions-packs-add-pack-create", "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pack" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Pack" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Pack" } } }, "required": true }, "security": [ { "supabase_session_inactive_allowed": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pack" } } }, "description": "" } }, "description": "Subscriptions packs add pack" } }, "/subscriptions/packs/add_payg_pack/": { "post": { "operationId": "subscriptions-packs-add-payg-pack-create", "description": "Start the free pay-as-you-go plan for an organization.\n\nThe plan never expires: the first pack.free_members_count member(s) are free\nand only additional members are billed through Stripe. Eligible signups\n(business email whose domain hasn't used a plan before, org's first plan)\nalso receive the pack's one-time complimentary credits in the never-expiring\nbalance. Orgs whose previous plan expired or was cancelled can activate too,\nwith 0 complimentary credits. Phone verification is required only when\ncomplimentary credits will be granted.", "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pack" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Pack" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Pack" } } }, "required": true }, "security": [ { "supabase_session_inactive_allowed": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pack" } } }, "description": "" } } } }, "/subscriptions/packs/check-trial-eligibility/": { "get": { "operationId": "subscriptions-packs-check-trial-eligibility-retrieve", "description": "Check if user's domain is eligible for free developer trial.\n\nReturns:\n - eligible: Boolean indicating if trial can be activated\n - reason: Code indicating why trial is not available (if applicable)\n - message: Human-readable message for frontend display", "tags": [ "subscriptions" ], "security": [ { "supabase_session_inactive_allowed": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pack" } } }, "description": "" } } } }, "/subscriptions/packs/switch_to_payg/": { "post": { "operationId": "subscriptions-packs-switch-to-payg-create", "description": "Switch an active legacy Stripe-managed self-serve plan, an inactive\nplan, or any other plan whose grace period has elapsed onto the free\nfirst-user-free pay-as-you-go plan. Admin-only, opt-in from billing.\n\nWhat it does: cancels the old Stripe subscription immediately (unpaid\ninvoices voided), moves the Stripe customer/card to the org, clears\nrecurring plan credits, and creates a seat subscription for members\nbeyond the free seats that starts billing only when the already-paid\nperiod ends. Purchased extra credits carry over only from an active,\nnon-overdue plan. No complimentary credits.", "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pack" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Pack" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Pack" } } }, "required": true }, "security": [ { "supabase_session_inactive_allowed": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pack" } } }, "description": "" } } } }, "/subscriptions/stripe/webhook/": { "post": { "operationId": "subscriptions-stripe-webhook-create", "tags": [ "subscriptions" ], "responses": { "200": { "description": "No response body" } }, "description": "Subscriptions stripe webhook" } }, "/subscriptions/subscriptions/": { "get": { "operationId": "subscriptions-subscriptions-list", "tags": [ "subscriptions" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } } }, "description": "" } }, "description": "List subscriptions subscriptions" } }, "/subscriptions/subscriptions/{id}/": { "get": { "operationId": "subscriptions-subscriptions-retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "subscriptions" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "" } }, "description": "Retrieve a subscriptions subscription by ID" } }, "/subscriptions/subscriptions/{id}/cancel/": { "post": { "operationId": "subscriptions-subscriptions-cancel-create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "" } }, "description": "Subscriptions subscriptions cancel" } }, "/subscriptions/subscriptions/{id}/mandate-setup-intent/": { "post": { "operationId": "subscriptions-subscriptions-mandate-setup-intent-create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "" } }, "description": "Subscriptions subscriptions mandate setup intent" } }, "/subscriptions/subscriptions/{id}/reactivate/": { "post": { "operationId": "subscriptions-subscriptions-reactivate-create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "" } }, "description": "Subscriptions subscriptions reactivate" } }, "/subscriptions/subscriptions/{id}/renew/": { "post": { "operationId": "subscriptions-subscriptions-renew-create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "" } }, "description": "Subscriptions subscriptions renew" } }, "/subscriptions/subscriptions/{id}/restart-seat-billing/": { "post": { "operationId": "subscriptions-subscriptions-restart-seat-billing-create", "description": "Recreate the seat subscription of a perpetual (free base) plan after its\npaid seats ended (voluntary cancellation completed, or payment failure\nafter dunning). One click when a card is on file: charges immediately\nfor the current billable seats and lifts the overdue member block —\nno dependency on the setup-checkout webhook.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "" } } } }, "/subscriptions/subscriptions/{id}/select-first-paid-seat-plan/": { "post": { "operationId": "subscriptions-subscriptions-select-first-paid-seat-plan-create", "description": "Resolve a one-time paid-plan choice.\n\nPAYG organizations see it before their first paid seat; developer-trial\norganizations can use it from Manage Plan. Sending the current pack code\nkeeps pay-as-you-go. Sending the configured ``allow_switch_to_plan`` code\ncreates and charges that monthly subscription immediately. Pricing, Stripe\nIDs, and the customer are always server-owned.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "" } } } }, "/subscriptions/subscriptions/{id}/setup-payment-method/": { "post": { "operationId": "subscriptions-subscriptions-setup-payment-method-create", "description": "Start a Stripe setup-mode checkout to save a payment method for the\norganization. Used by plans without a Stripe subscription (e.g. the free\npay-as-you-go plan) before top-ups, auto-refill, or adding paid members.\nThe checkout.session.completed webhook makes the card the customer default.\n\nOptional body field `return_path` (relative path, e.g. \"/onboarding/ui\")\nsends the user back to the page they started from after Stripe; invalid\nor missing paths fall back to the global STRIPE_SUCCESS_URL/CANCEL_URL.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "" } } } }, "/subscriptions/subscriptions/{id}/update_payment_method/": { "post": { "operationId": "subscriptions-subscriptions-update-payment-method-create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "" } }, "description": "Subscriptions subscriptions update payment method" } }, "/subscriptions/subscriptions/create_portal_session/": { "post": { "operationId": "subscriptions-subscriptions-create-portal-session-create", "tags": [ "subscriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Subscription" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } }, "description": "" } }, "description": "Create a new subscriptions subscriptions create portal session" } }, "/test_framework/billing/": { "get": { "operationId": "test-framework-billing-list", "description": "List billing information", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Billing" } } } }, "description": "" } } } }, "/test_framework/billing/{id}/add-credits/": { "post": { "operationId": "test-framework-billing-add-credits-create", "description": "Process a one-time payment to add credits to organization balance.\nAlternative to auto-refill for manual credit purchases.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this billing.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Billing" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Billing" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Billing" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Billing" } } }, "description": "" } } } }, "/test_framework/billing/{id}/credits-usage/": { "get": { "operationId": "test-framework-billing-credits-usage-retrieve", "description": "Get credits usagesummary for the current billing cycle.\n\nReturns:\n- billing_cycle: start_date and end_date of current billing period\n- credits:\n - pack_balance: credits from subscription pack\n - balance: current main balance\n - extra_balance: never-expiry balance\n - total_balance: total balance (balance + extra_balance)\n - used_by_simulation: credits used by Run (testing/simulation)\n - used_by_observability: credits used by CallLog (observability)\n - total_used_credits: total credits consumed", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this billing.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Billing" } } }, "description": "" } } } }, "/test_framework/billing/{id}/usage-chart/": { "get": { "operationId": "test-framework-billing-usage-chart-retrieve", "description": "Returns transaction usage data split by testing (Run) and call evaluations (CallLog) aggregated by day. Shows net usage (deducted - refunded). By default, shows data for the last 30 days. Supports flexible filtering using JSON filter format.", "summary": "Get usage chart data", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this billing.", "required": true }, { "in": "query", "name": "time_period", "schema": { "type": "string", "enum": [ "day", "hour", "month", "week" ] }, "description": "Time period for aggregation (hour, day, week, month). Default: day" }, { "in": "query", "name": "split_by_type", "schema": { "type": "boolean" }, "description": "Split data by source type (Run vs CallLog). Default: true" }, { "in": "query", "name": "filters", "schema": { "type": "object" }, "description": "Optional JSON filters using TransactionQueryFilter format. If not provided, defaults to last 30 days. Example: {\"operator\": \"and\", \"conditions\": [{\"field\": \"created_at\", \"op\": \"gte\", \"value\": \"2025-11-01T00:00:00Z\"}]}" } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageChartResponse" } } }, "description": "" }, "400": { "description": "Invalid parameters" }, "404": { "description": "Billing not found" } } } }, "/test_framework/billing/info/": { "get": { "operationId": "billing-info-retrieve", "description": "Returns credits remaining, current billing-cycle credits used, balance expiry, and subscription status for an organization. Credits used comes from the current billing-cycle aggregate and may lag usage by up to 30 minutes. When called with an organization-scoped API key, the org is taken from the key. When called with a user session or OAuth bearer, pass `organization_id` as a query parameter — the caller must be an admin of that organization.", "summary": "Get billing information", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingInfo" } } }, "description": "" }, "403": { "description": "Project-scoped API keys are not allowed" }, "404": { "description": "Billing information not found" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "billing-info-retrieve", "description": "Returns credits remaining, current billing-cycle credits used, balance expiry, and subscription status for an organization. Credits used comes from the current billing-cycle aggregate and may lag usage by up to 30 minutes. When called with an organization-scoped API key, the org is taken from the key. When called with a user session or OAuth bearer, pass `organization_id` as a query parameter — the caller must be an admin of that organization." } }, "parameters": [ { "name": "organization_id", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `organization_id` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ] } }, "/test_framework/billing/metric-usage/": { "get": { "operationId": "test-framework-billing-metric-usage-retrieve", "description": "Billing metric usage", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Billing" } } }, "description": "" } } } }, "/test_framework/billing/payment-history/": { "get": { "operationId": "billing-payment-history", "description": "Returns a paginated list of all payments (auto-pay, one-time, subscription) made by the organization.", "summary": "Get payment history", "parameters": [ { "in": "query", "name": "organization_id", "schema": { "type": "integer" }, "description": "Organization ID", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentHistory" } } } }, "description": "" }, "400": { "description": "organization_id is required" }, "404": { "description": "Organization not found" } } } }, "/test_framework/billing/runs/": { "get": { "operationId": "test-framework-billing-runs-retrieve", "description": "Billing runs", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Billing" } } }, "description": "" } } } }, "/test_framework/billing/status/": { "get": { "operationId": "test-framework-billing-status-retrieve", "description": "Billing status", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Billing" } } }, "description": "" } } } }, "/test_framework/billing/usage-history/": { "get": { "operationId": "test-framework-billing-usage-history-retrieve", "description": "Billing usage history", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Billing" } } }, "description": "" } } } }, "/test_framework/critical-categories/{id}/": { "put": { "operationId": "test-framework-critical-categories-update", "description": "Update critical metric categories for organizing flagged conversation patterns.\n\nCategories group critical metric scenarios by theme (e.g., compliance violations,\nsafety issues) to help prioritize agent improvements.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } } }, "description": "" } } }, "patch": { "operationId": "test-framework-critical-categories-partial-update", "description": "Update critical metric categories for organizing flagged conversation patterns.\n\nCategories group critical metric scenarios by theme (e.g., compliance violations,\nsafety issues) to help prioritize agent improvements.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCriticalMetricCategory" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCriticalMetricCategory" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCriticalMetricCategory" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } } }, "description": "" } } } }, "/test_framework/custom-provider-transcript-webhook/": { "post": { "operationId": "test-framework-custom-provider-transcript-webhook-create", "description": "Handle incoming webhook POST requests.", "tags": [ "test_framework" ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/test_framework/metric-reviews/{id}/": { "put": { "operationId": "metric-reviews-update", "description": "Manage metric reviews in the Labs improvement workflow.\n\nMetric reviews capture human feedback (agree/disagree) on metric evaluation results.\nThis feedback is used to iteratively improve metric prompts and scoring accuracy\nthrough the Labs pipeline.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric review.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } } }, "description": "" } } }, "patch": { "operationId": "metric-reviews-partial-update", "description": "Update a metric review in Labs. Typically used to add or update feedback notes for test sets.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric review.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedMetricReviewInline" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedMetricReviewInline" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedMetricReviewInline" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Update a metric review", "x-mint": { "mcp": { "enabled": true, "name": "metric-reviews-partial-update", "description": "Update a metric review in Labs. Typically used to add or update feedback notes for test sets." } } }, "delete": { "operationId": "metric-reviews-destroy", "description": "Manage metric reviews in the Labs improvement workflow.\n\nMetric reviews capture human feedback (agree/disagree) on metric evaluation results.\nThis feedback is used to iteratively improve metric prompts and scoring accuracy\nthrough the Labs pipeline.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric review.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/metric-reviews/{id}/process_feedback/": { "post": { "operationId": "test-framework-metric-reviews-process-feedback-create", "description": "Process feedback for a metric description and evaluation trigger.\n\nThis endpoint takes agent description, transcript, current metric description,\ncurrent evaluation trigger, and feedback to generate improved versions.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } } }, "description": "" } } } }, "/test_framework/metric-reviews/delete_reviews/": { "post": { "operationId": "test-framework-metric-reviews-delete-reviews-create", "description": "Manage metric reviews in the Labs improvement workflow.\n\nMetric reviews capture human feedback (agree/disagree) on metric evaluation results.\nThis feedback is used to iteratively improve metric prompts and scoring accuracy\nthrough the Labs pipeline.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } } }, "description": "" } } } }, "/test_framework/metric-reviews/optimizer_chat_cancel/": { "post": { "operationId": "metric-reviews-optimizer-chat-cancel", "description": "Cancel a post-optimization chat session (stops any in-flight agent turn / regression check), or mark it completed with reason='applied' after the proposal has been applied.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Session cancelled or completed" } } } }, "/test_framework/metric-reviews/optimizer_chat_confirm_samples/": { "post": { "operationId": "metric-reviews-optimizer-chat-confirm-samples", "description": "Confirm which of the agent's proposed regression samples to add to the eval set, and whether to re-optimize afterwards. The chat agent only proposes — this endpoint is what actually writes the eval set.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "Samples added; progress_id when re-optimizing" } } } }, "/test_framework/metric-reviews/optimizer_chat_message/": { "post": { "operationId": "metric-reviews-optimizer-chat-message", "description": "Send a message (and/or structured regression-review verdicts) to the post-optimization review agent. Poll optimizer_chat_progress with the returned progress_id.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptimizerChatMessageRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OptimizerChatMessageRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OptimizerChatMessageRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns progress_id for the agent turn" } } } }, "/test_framework/metric-reviews/optimizer_chat_progress/": { "get": { "operationId": "metric-reviews-optimizer-chat-progress", "description": "Poll a post-optimization chat turn.", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Chat turn progress state" } } } }, "/test_framework/metric-reviews/optimizer_chat_regression/": { "post": { "operationId": "metric-reviews-optimizer-chat-regression", "description": "Run the optimized proposal on the most recent calls/runs this metric previously evaluated (outside the eval set) and diff the labels. Evaluations are billed like production metric runs.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns progress_id for the regression check" } } } }, "/test_framework/metric-reviews/optimizer_chat_regression_progress/": { "get": { "operationId": "metric-reviews-optimizer-chat-regression-progress", "description": "Poll a regression check.", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Regression check progress state" } } } }, "/test_framework/metric-reviews/optimizer_chat_reoptimize/": { "post": { "operationId": "metric-reviews-optimizer-chat-reoptimize", "description": "Re-run the optimizer using this review session's current eval set.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptimizerChatReoptimizeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OptimizerChatReoptimizeRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OptimizerChatReoptimizeRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns progress_id for the re-optimization" } } } }, "/test_framework/metric-reviews/optimizer_chat_session/": { "get": { "operationId": "metric-reviews-optimizer-chat-session", "description": "Rehydrate a post-optimization review chat session.", "parameters": [ { "in": "query", "name": "session_id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricOptimizerChatSession" } } }, "description": "" } } } }, "/test_framework/metric-reviews/optimizer_chat_start/": { "post": { "operationId": "metric-reviews-optimizer-chat-start", "description": "Open (or resume) the post-optimization review chat for a metric. Seeds the session from a completed process_feedbacks run (progress_id) or from the metric's pending optimisation proposal.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptimizerChatStartRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OptimizerChatStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OptimizerChatStartRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricOptimizerChatSession" } } }, "description": "" } } } }, "/test_framework/metric-reviews/process_feedbacks/": { "post": { "operationId": "metric-reviews-process-feedbacks", "description": "Improve a metric using feedback from test sets. Returns improved metric configuration. Use the Update Metric endpoint to save changes.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessFeedbacksRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProcessFeedbacksRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProcessFeedbacksRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns progress_id for tracking progress" } }, "x-mcp-expose": true, "summary": "Improve a metric from feedback", "x-mint": { "mcp": { "enabled": true, "name": "metric-reviews-process-feedbacks", "description": "Improve a metric using feedback from test sets. Returns improved metric configuration. Use the Update Metric endpoint to save changes." } } } }, "/test_framework/metric-reviews/process_feedbacks_answer/": { "post": { "operationId": "metric-reviews-process-feedbacks-answer", "description": "Answer the questions a running metric optimization is paused on. Answers are keyed by question id; use {\"action\": \"skip\"} to skip one.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Answers recorded; the paused optimization resumes" } } } }, "/test_framework/metric-reviews/process_feedbacks_cancel/": { "post": { "operationId": "test-framework-metric-reviews-process-feedbacks-cancel-create", "description": "Cancel a running optimization. Used after the user edits a flagged\nannotation so the run can be restarted with the corrected dataset\ninstead of finishing with the old labels.\n\nPOST { progress_id }", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricReviewInline" } } }, "description": "" } } } }, "/test_framework/metric-reviews/process_feedbacks_progress/": { "get": { "operationId": "metric-reviews-process-feedbacks-progress", "description": "Poll the progress of metric optimization from feedback processing. Returns the improved metric description and evaluation trigger when complete.", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "description": "Progress ID returned from the process_feedbacks endpoint", "required": true }, { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "Agent ID for permission validation" }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "Project ID for permission validation" } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessFeedbacksResponse" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Get metric improvement progress", "x-mint": { "mcp": { "enabled": true, "name": "metric-reviews-process-feedbacks-progress", "description": "Poll the progress of metric optimization from feedback processing. Returns the improved metric description and evaluation trigger when complete." } } } }, "/test_framework/metric-rolling-stats/": { "get": { "operationId": "test-framework-metric-rolling-stats-list", "description": "List rolling statistics", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedMetricRollingStatsList" } } }, "description": "" } } }, "post": { "operationId": "test-framework-metric-rolling-stats-create", "description": "Create a new rolling statistic", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricRollingStats" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricRollingStats" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricRollingStats" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricRollingStats" } } }, "description": "" } } } }, "/test_framework/metric-rolling-stats/{id}/": { "get": { "operationId": "test-framework-metric-rolling-stats-retrieve", "description": "Retrieve a rolling statistic by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric rolling stats.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricRollingStats" } } }, "description": "" } } }, "put": { "operationId": "test-framework-metric-rolling-stats-update", "description": "Update a rolling statistic", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric rolling stats.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricRollingStatsPatch" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricRollingStatsPatch" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricRollingStatsPatch" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricRollingStatsPatch" } } }, "description": "" } } }, "patch": { "operationId": "test-framework-metric-rolling-stats-partial-update", "description": "Enhanced partial_update with automatic project-level bulk updates.\nIf the metric is project-level, updates all MetricRollingStats for that metric.\nOtherwise, performs a single update.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric rolling stats.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedMetricRollingStatsPatch" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedMetricRollingStatsPatch" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedMetricRollingStatsPatch" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricRollingStatsPatch" } } }, "description": "" } } }, "delete": { "operationId": "test-framework-metric-rolling-stats-destroy", "description": "Delete a rolling statistic", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric rolling stats.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/process-message-response/": { "post": { "operationId": "test-framework-process-message-response-create", "description": "API view to process incoming message responses from VAPI.\nThis view handles the storage of incoming webhook data and updates\nthe status of runs based on the call status received in the payload.", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/test_framework/process-patronus-message-response/": { "post": { "operationId": "test-framework-process-patronus-message-response-create", "description": "API view to process incoming message responses from the voice service.\nThis view handles the storage of incoming webhook data and updates\nthe status of runs based on the call status received in the payload.", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/test_framework/test-sets/create_from_call_log/": { "post": { "operationId": "test-sets-create-from-call-log", "description": "Promote a real production call into a labeled test set by attaching the specified metrics. The call's transcript, recording, and any existing metric evaluations are copied into the new test set so they can be reviewed and used as labeled ground truth. Returns the created or existing test set.", "summary": "Create a test set from a production call log", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateFromCallLogRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateFromCallLogRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateFromCallLogRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSetDetail" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "test-sets-create-from-call-log", "description": "Promote a real production call into a labeled test set by attaching the specified metrics. The call's transcript, recording, and any existing metric evaluations are copied into the new test set so they can be reviewed and used as labeled ground truth. Returns the created or existing test set." } } } }, "/test_framework/test-sets/create_from_call_logs/": { "post": { "operationId": "test-framework-test-sets-create-from-call-logs-create", "description": "Manage test sets for organizing and curating evaluation data.\n\nTest sets are collections of call transcripts or run data used for metric\nreview and improvement via the Labs workflow. Create test sets from call logs\nor previous runs to build a curated evaluation dataset.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateFromCallLogsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateFromCallLogsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateFromCallLogsRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSetDetail" } } }, "description": "" } } } }, "/test_framework/test-sets/create_from_run/": { "post": { "operationId": "test-sets-create-from-run", "description": "Promote a completed test run into a labeled test set by attaching the specified metrics. Existing metric scores from the run are copied as the initial 'actual' values; the caller provides 'expected' values for review. Returns the created or existing test set.", "summary": "Create a test set from a previous test run", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateFromRunRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateFromRunRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateFromRunRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSetDetail" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "test-sets-create-from-run", "description": "Promote a completed test run into a labeled test set by attaching the specified metrics. Existing metric scores from the run are copied as the initial 'actual' values; the caller provides 'expected' values for review. Returns the created or existing test set." } } } }, "/test_framework/test-sets/create_from_runs/": { "post": { "operationId": "test-framework-test-sets-create-from-runs-create", "description": "Manage test sets for organizing and curating evaluation data.\n\nTest sets are collections of call transcripts or run data used for metric\nreview and improvement via the Labs workflow. Create test sets from call logs\nor previous runs to build a curated evaluation dataset.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFromRunsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateFromRunsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateFromRunsRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSetDetail" } } }, "description": "" } } } }, "/test_framework/v1/aiagents/": { "get": { "operationId": "aiagents-v1-list", "description": "aiagents_list: List AI voice agents in your account. Filter by `project_id` to scope to one project, or omit to list every agent the caller can access. Returns a paginated list of agent summaries (id, name, provider, contact number, created/updated timestamps).\n\nPerformance tip: passing `project_id` from your workspace context narrows the result. Try `page_size=20` first — you can paginate or raise the page size if you actually need more.", "summary": "List AI voice agents", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "Filter by project ID" }, { "in": "query", "name": "q", "schema": { "type": "string" }, "description": "Search agents by name. A numeric value also matches the agent id." } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAIAgentList" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } }, "post": { "operationId": "aiagents-v1-create", "description": "aiagents_create: Register a new AI voice agent with Cekura for testing / observability. Required: `agent_name`, `project` (project ID), `assistant_provider`. Other fields depend on the provider (see below).\n\n**Most common case:** you already have an agent running on your own provider stack with a dedicated phone number. Pass `agent_name`, `description`, `inbound`, `project`, `contact_number` (E.164 format, e.g. `+14155551234`), and `language` — Cekura observes that number without needing provider credentials. Set `assistant_provider=\"self_hosted\"` (optionally `websocket_url` for text-mode runs).\n\n**Provider integrations:** set `assistant_provider` to one of the valid values below and pass the matching credentials. `assistant_id` alone does NOT substitute for provider credentials — providers like VAPI, Retell, and Bland validate their api_key on create.\n\n**Valid `assistant_provider` values** (live enum — superset of prose docs you may see elsewhere):\n- `self_hosted` — websocket or observation-only; no api_key needed. Use `websocket_url` + `websocket_headers` for text-mode runs.\n- `vapi` — requires `vapi_api_key`; optional `assistant_id`, `vapi_data.public_key`.\n- `retell` — requires `retell_api_key` AND `chat_assistant_id` (yes — Retell uses this field even for voice).\n- `bland` — requires `bland_api_key` AND `chat_assistant_id` (Bland internally calls this `pathway_id`); `bland_data.encrypted_key` for Twilio.\n- `livekit` — requires `livekit_api_key` + `livekit_data.url`; `livekit_data.api_secret` is needed at run time for WebRTC.\n- `elevenlabs` — requires `elevenlabs_api_key`.\n- `agentforce` — Salesforce Agentforce; needs `agentforce_client_secret` + `agentforce_data` (client_id, domain, agent_id).\n- `cisco` — Cisco Webex.\n- `vocera` — Cekura-hosted agent.\n- `sms` — text-only SMS channel; use `chat_assistant_id`.\n- `whatsapp` — text-only WhatsApp channel; use `chat_assistant_id`.\n- `\"\"` (empty string) — unset; agent is not runnable until a provider is configured.\n\n**Note:** the serializer exposes fields for some providers (`pipecat_*`, `synthflow_*`, `koreai_*`, `genesys_*`, `custom_provider_*`) that are NOT currently in the `assistant_provider` enum. Those fields exist for response/config purposes but the matching provider value cannot be selected today.\n\n**Outbound agents:** set `inbound=false`. Actual call placement uses the scenario's configured phone number or a number from the org's provisioned pool — `outbound_numbers` is not required for calls to be placed (it is used for webhook validation only).\n\n**Other fields to know:**\n- `language` — BCP-47 locale (`en`, `es`, `fr`, …). Must match the personalities used for evaluators.\n- `transcript_provider` — STT vendor (`vapi | retell | synthflow | elevenlabs | bland | livekit | pipecat | koreai | custom | cisco | genesys`). Does NOT auto-pair with `assistant_provider`; set both independently when needed.\n- `llm_model`, `llm_temperature`, `llm_max_tokens`, `llm_system_prompt` — simulation LLM settings (used by Cekura when simulating callers in test runs; NOT your agent's own LLM).\n- `auto_fetch_calls_enabled` — auto-import calls from the provider every 30s (VAPI/Retell/ElevenLabs/Bland).\n- `auto_sync_prompt_enabled` — one-way prompt sync from the provider to Cekura on a schedule; Cekura updates its agent description and does not push changes back to the provider. Supported for VAPI, Retell, ElevenLabs, Synthflow, Telnyx, and Bland.\n\n**Read-only status fields** like `vapi_api_key_configured`, `retell_api_key_configured` appear in the response to indicate which provider credentials are stored (credentials themselves are masked).", "summary": "Create an AI voice agent", "tags": [ "AI Agents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgent" }, "examples": { "Self-hosted(contactNumberOnly—MostCommon)": { "value": { "agent_name": "Support Bot", "description": "Handles inbound support calls for ACME Inc.", "inbound": true, "project": 1376, "contact_number": "+14155551234", "language": "en", "assistant_provider": "self_hosted" }, "summary": "Self-hosted (contact number only — most common)", "description": "Typical onboarding: your agent is already deployed on your own stack with a phone number. Cekura just observes and evaluates; no provider credentials needed." }, "VAPIAgent": { "value": { "agent_name": "VAPI Sales Agent", "description": "Outbound sales qualification calls", "inbound": false, "project": 1376, "contact_number": "+14155551234", "language": "en", "assistant_provider": "vapi", "vapi_api_key": "vapi_sk_xxx", "vapi_data": { "public_key": "vapi_pk_xxx" }, "assistant_id": "asst_abc123" }, "summary": "VAPI agent" }, "RetellAgent": { "value": { "agent_name": "Retell Booking Agent", "description": "Schedules dental appointments", "inbound": true, "project": 1376, "contact_number": "+14155551234", "language": "en", "assistant_provider": "retell", "retell_api_key": "key_xxx", "chat_assistant_id": "retell_agent_abc123", "retell_data": { "trigger_url": "https://api.retellai.com/create-phone-call" } }, "summary": "Retell agent", "description": "Retell requires BOTH retell_api_key AND chat_assistant_id (used for voice too, despite the field's name)." }, "BlandAgent": { "value": { "agent_name": "Bland Support Agent", "description": "Handles tier-1 billing questions", "inbound": true, "project": 1376, "contact_number": "+14155551234", "language": "en", "assistant_provider": "bland", "bland_api_key": "bland_xxx", "chat_assistant_id": "bland_pathway_xyz", "bland_data": { "encrypted_key": "twilio_encrypted_key_xxx" } }, "summary": "Bland agent", "description": "Bland requires bland_api_key AND chat_assistant_id (Bland calls this field pathway_id internally). bland_data.encrypted_key is the Twilio credential bundle." }, "LiveKitAgent": { "value": { "agent_name": "LiveKit Concierge", "description": "Multi-modal front-desk agent", "inbound": true, "project": 1376, "language": "en", "assistant_provider": "livekit", "livekit_api_key": "APIxxx", "livekit_data": { "api_secret": "secret_xxx", "url": "wss://acme.livekit.cloud" } }, "summary": "LiveKit agent" }, "Self-hostedViaWebsocketURL": { "value": { "agent_name": "Internal Test Agent", "description": "Staging build of the support flow", "inbound": false, "project": 1376, "assistant_provider": "self_hosted", "websocket_url": "wss://staging.example.com/agent", "websocket_headers": { "Authorization": "Bearer token_xxx" }, "language": "en" }, "summary": "Self-hosted via websocket URL", "description": "Your agent exposes a websocket endpoint for text-mode testing." } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AIAgent" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AIAgent" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgent" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{agent_id}/dynamic-variable/{id}/": { "patch": { "operationId": "dynamic-variables-partial-update", "description": "Partially updates a single dynamic variable definition by ID.", "summary": "Update a dynamic variable definition", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true }, { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true } ], "tags": [ "Dynamic Variables" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAIAgentDynamicVariable" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAIAgentDynamicVariable" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAIAgentDynamicVariable" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentDynamicVariable" } } }, "description": "" } } }, "delete": { "operationId": "dynamic-variables-destroy", "description": "Soft-deletes a single dynamic variable definition by ID.", "summary": "Delete a dynamic variable definition", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true }, { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true } ], "tags": [ "Dynamic Variables" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/aiagents/{agent_id}/dynamic-variables/": { "get": { "operationId": "dynamic-variables-list", "description": "Returns all user-defined dynamic variable definitions for the agent, ordered by name.", "summary": "List dynamic variable definitions for an agent", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true } ], "tags": [ "Dynamic Variables" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentDynamicVariable" } } } }, "description": "" } } }, "post": { "operationId": "dynamic-variables-create", "description": "Upserts a list of dynamic variable definitions for the agent. Each entry is matched by `name` — existing variables are updated, new ones are created. Pass a JSON array of `{name, description}` objects. Returns the complete list of definitions after the operation.", "summary": "Upsert dynamic variable definitions (bulk, by name)", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true } ], "tags": [ "Dynamic Variables" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentDynamicVariable" } }, "examples": { "UpsertTwoVariables": { "value": [ [ { "name": "prompt", "description": "Full system prompt for this call" }, { "name": "agent_type", "description": "Role of the agent (sales, support, ...)" } ] ], "summary": "Upsert two variables" } } }, "application/x-www-form-urlencoded": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentDynamicVariable" } } }, "multipart/form-data": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentDynamicVariable" } } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIAgentDynamicVariable" } } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{agent_id}/mcp/{mock_index}/": { "post": { "operationId": "aiagents-mcp-create", "description": "Mock MCP server endpoint.\n\nImplements the MCP JSON-RPC 2.0 protocol so VAPI can use a Cekura-hosted\nmock in place of a real MCP server. Handles three methods:\n\n initialize — standard MCP handshake\n tools/list — returns Tool records for this specific MCP endpoint only\n tools/call — looks up the named Tool and returns its mock output\n\nURL: /v1/aiagents/{agent_id}/mcp/{mock_index}/\nEach original VAPI MCP tool gets its own sequential index (1, 2, 3 ...) so\nthat different MCP tools on the same assistant each serve only their own\nsub-tools and never mix with each other.\n\nNo authentication is required — this endpoint must be reachable by VAPI.", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true }, { "in": "path", "name": "mock_index", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true } ], "tags": [ "test_framework" ], "responses": { "200": { "description": "No response body" } } } }, "/test_framework/v1/aiagents/{agent_id}/tool/{tool_name}/": { "get": { "operationId": "aiagents-tool-retrieve", "description": "Return a single tool's full definition, including the input/output pairs that define its mock responses. Use it to inspect what a tool returns before updating it or enabling mock mode.", "summary": "Get an agent's tool by name", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true }, { "in": "path", "name": "tool_name", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "deprecated": true, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tool" }, "examples": { "GetToolResponse": { "value": { "id": 1, "name": "tool_user_data", "description": "This tool retrieves user data from the database based on user ID", "information": [ { "input": { "user_id": 1 }, "output": { "name": "John Doe", "age": 30, "email": "john@example.com" } }, { "input": { "user_id": 2 }, "output": { "name": "Jane Smith", "age": 25, "email": "jane@example.com" } } ] }, "summary": "Get Tool Response" } } } }, "description": "" } } }, "post": { "operationId": "aiagents-tool-create", "description": "Execute tool by matching input and returning corresponding output.\n\nSupports two payload formats:\n1. Flat input (default): {\"param1\": \"value1\", \"param2\": \"value2\"}\n2. VAPI function format: {\"message\": {\"type\": \"tool-calls\", \"toolCallList\": [{\"id\": \"...\", \"arguments\": {...}}]}}", "summary": "Execute a mock tool (provider webhook)", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true }, { "in": "path", "name": "tool_name", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "deprecated": true, "responses": { "201": { "description": "No response body" } } }, "patch": { "operationId": "aiagents-tool-partial-update", "description": "Patch a tool's fields — its `name`, `description`, or `information` (the list of input/output pairs that define its mock responses). Only the fields you send are changed.", "summary": "Update an agent's tool by name", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true }, { "in": "path", "name": "tool_name", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTool" }, "examples": { "UpdateToolRequest": { "value": { "name": "tool_user_data", "description": "This tool retrieves user data from the database based on user ID", "information": [ { "input": { "user_id": 1 }, "output": { "name": "John Doe", "age": 30, "email": "john@example.com" } }, { "input": { "user_id": 2 }, "output": { "name": "Jane Smith", "age": 25, "email": "jane@example.com" } } ] }, "summary": "Update Tool Request" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedTool" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedTool" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "deprecated": true, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tool" }, "examples": { "UpdateToolResponse": { "value": { "id": 1, "agent": 123, "name": "tool_user_data", "description": "This tool retrieves user data from the database based on user ID", "information": [ { "input": { "user_id": 1 }, "output": { "name": "John Doe", "age": 30, "email": "john@example.com" } }, { "input": { "user_id": 2 }, "output": { "name": "Jane Smith", "age": 25, "email": "jane@example.com" } } ] }, "summary": "Update Tool Response" } } } }, "description": "" } } }, "delete": { "operationId": "aiagents-tool-destroy", "description": "Detaches the named tool from this agent by marking it deleted. The tool definition is not deleted — other agents referencing the same tool_name are unaffected.", "summary": "Remove a tool from an agent", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true }, { "in": "path", "name": "tool_name", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "deprecated": true, "responses": { "204": { "description": "No response body" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{agent_id}/tools/": { "get": { "operationId": "aiagents-tools-list", "description": "Return every tool configured on the agent, including mock tools and the input/output pairs that define their mock responses. Use this to see what's set up before enabling or disabling mock mode or updating a specific tool.", "summary": "List an agent's tools", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "deprecated": true, "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Tool" } }, "examples": { "ListToolsResponse": { "value": [ { "id": 1, "name": "tool_user_data", "description": "This tool retrieves user data from the database based on user ID", "information": [ { "input": { "user_id": 1 }, "output": { "name": "John Doe", "age": 30, "email": "john@example.com" } }, { "input": { "user_id": 2 }, "output": { "name": "Jane Smith", "age": 25, "email": "jane@example.com" } } ] } ], "summary": "List Tools Response" } } } }, "description": "" } } }, "post": { "operationId": "aiagents-tools-create", "description": "Register a tool on the agent, including its mock input/output pairs in `information`. For agents on a managed provider, prefer auto-fetch to import tools automatically; use this to add a custom or hand-authored tool.", "summary": "Add a tool to an agent", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tool" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Tool" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Tool" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "deprecated": true, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tool" }, "examples": { "CreateToolResponse": { "value": { "name": "tool_user_data", "description": "This tool retrieves user data from the database based on user ID", "information": [ { "input": { "user_id": 1 }, "output": { "name": "John Doe", "age": 30, "email": "john@example.com" } }, { "input": { "user_id": 2 }, "output": { "name": "Jane Smith", "age": 25, "email": "jane@example.com" } } ] }, "summary": "Create Tool Response" } } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{agent_id}/tools/auto-fetch/": { "post": { "operationId": "aiagents-tools-auto-fetch-create", "description": "Discover the agent's tools (from a managed provider or a customer-hosted MCP server) and LLM-generate mock input/output data for each. Persists Tool rows and records the provider configuration on the agent. ⚠ Overwrites empty Tool rows; existing rows with mock data are kept. For provider=\"custom\", supply `mcp_server_url`; the URL is SSRF-validated (no private/loopback targets).", "summary": "Auto-fetch mock tools for an agent", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoFetchToolsRequest" }, "examples": { "Auto-FetchToolsRequest(managedProvider)": { "value": { "provider": "retell", "assistant_id": "agent_abc123" }, "summary": "Auto-Fetch Tools Request (managed provider)" }, "Auto-FetchToolsRequest(customMCPServer)": { "value": { "provider": "custom", "mcp_server_url": "https://customer.example.com/mcp", "mcp_server_headers": { "Authorization": "Bearer ..." } }, "summary": "Auto-Fetch Tools Request (custom MCP server)" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AutoFetchToolsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AutoFetchToolsRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "deprecated": true, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoFetchToolsResponse" }, "examples": { "Auto-FetchToolsSuccessResponse": { "value": { "progress_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "summary": "Auto-Fetch Tools Success Response" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoFetchErrorResponse" } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{agent_id}/tools/auto-fetch-progress/": { "get": { "operationId": "aiagents-tools-auto-fetch-progress-retrieve", "description": "Poll the status of a background auto-fetch tools task.\n\nReturns the current state: in_progress, completed (with counts), or failed (with error).", "summary": "Poll auto-fetch tool import progress", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true }, { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "deprecated": true, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoFetchProgressResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoFetchProgressErrorResponse" } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{agent_id}/tools/mock-status/": { "get": { "operationId": "aiagents-tools-mock-status-retrieve", "description": "Single source of truth for \"what mock-tool runtime URLs do I have, and what are they configured for?\". `mcp_endpoints[]` lists each Cekura-hosted MCP JSON-RPC endpoint with the sub-tools it serves; `tool_endpoints[]` lists standalone (non-MCP) per-tool webhook URLs. URLs are computed from `settings.CEKURA_BASE_URL`, so each environment renders the correct host.", "summary": "Current mock-tools state for an agent", "parameters": [ { "in": "path", "name": "agent_id", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "deprecated": true, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MockStatusResponse" } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{id}/": { "get": { "operationId": "aiagents-v1-retrieve", "description": "Retrieve an AI voice agent by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgent" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } }, "put": { "operationId": "aiagents-v1-update", "description": "Fully replace an AI agent's fields. Prefer `PATCH` (partial_update) unless you need full-replacement semantics. See `aiagents_create` for the field shape and per-provider examples.", "summary": "Replace an AI voice agent (full update)", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true } ], "tags": [ "AI Agents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaUpdateAIAgentExternal" }, "examples": { "ReplaceAgent(fullPayload)": { "value": { "agent_name": "Support Bot v2", "description": "Handles inbound support calls for ACME Inc.", "inbound": true, "project": 1376, "contact_number": "+14155551234", "language": "en", "assistant_provider": "self_hosted" }, "summary": "Replace agent (full payload)" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaUpdateAIAgentExternal" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaUpdateAIAgentExternal" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgent" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } }, "patch": { "operationId": "aiagents-v1-partial-update", "description": "Partially update an AI agent. Same field shape as create — see `aiagents_create` for details and per-provider examples.", "summary": "Update an AI voice agent (partial)", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true } ], "tags": [ "AI Agents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSchemaUpdateAIAgentExternal" }, "examples": { "Rename+UpdateDescription": { "value": { "agent_name": "Support Bot v2", "description": "Updated description" }, "summary": "Rename + update description" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedSchemaUpdateAIAgentExternal" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedSchemaUpdateAIAgentExternal" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgent" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } }, "delete": { "operationId": "aiagents-v1-destroy", "description": "⚠ Irreversible. Deletes the agent.\n\n**Cascade behaviour (controlled by `delete_related` query param):**\n- `delete_related=true` (default) — also deletes the agent's call logs, evaluators, results, and runs.\n- `delete_related=false` — detaches scenario evaluators (sets agent=null), and leaves call logs, metric evaluations, results, and runs untouched.", "summary": "Delete an AI voice agent", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true }, { "in": "query", "name": "delete_related", "schema": { "type": "boolean" }, "description": "If true (default), delete associated call logs, scenario evaluators, results and runs. If false, detach scenario evaluators and leave call logs, metric evaluations, results and runs as-is." } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{id}/delete_knowledge_base/": { "delete": { "operationId": "aiagents-v1-delete-knowledge-base-destroy", "description": "Aiagents v1 delete knowledge base", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted_count": { "type": "integer" } } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{id}/disable_personalities/": { "post": { "operationId": "aiagents-v1-disable-personalities-create", "description": "Aiagents v1 disable personalities", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgent" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AIAgent" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AIAgent" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgent" } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{id}/duplicate/": { "post": { "operationId": "aiagents-v1-duplicate-create", "description": "Aiagents v1 duplicate", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostCopyAgent" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostCopyAgent" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostCopyAgent" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgent" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{id}/enable_personalities/": { "post": { "operationId": "aiagents-v1-enable-personalities-create", "description": "Aiagents v1 enable personalities", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgent" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AIAgent" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AIAgent" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgent" } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{id}/history/": { "get": { "operationId": "aiagents-v1-history-list", "description": "Paginated version history for an agent: name/language/description plus the mock\ntools, dynamic variables, and knowledge base files active at each version.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "page_size", "schema": { "type": "integer" } } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAIAgentHistoryList" } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{id}/history/edit/": { "patch": { "operationId": "aiagents-v1-history-edit-partial-update", "description": "Edit metadata (e.g. version name) on a specific agent version.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAIAgentEditHistoryRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAIAgentEditHistoryRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAIAgentEditHistoryRequest" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentHistory" } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{id}/knowledge_base/": { "get": { "operationId": "aiagents-v1-knowledge-base-list", "description": "Aiagents v1 knowledge base", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedKnowledgeBaseFileList" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{id}/personalities/": { "get": { "operationId": "aiagents-v1-personalities-retrieve", "description": "Aiagents v1 personalities", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgent" } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{id}/restore/": { "post": { "operationId": "aiagents-v1-restore-create", "description": "Restore an agent to a previous version, creating a new version for the restore.\n\nRestores the versioned concrete fields (name, language, description) and the related\ncollections: tools and dynamic variables are reverted in place to their\nlinked versions (ids preserved) and any not in the version are soft-deleted; knowledge\nbase files referenced by the version are reactivated and the rest soft-deleted.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentRestoreRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AIAgentRestoreRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AIAgentRestoreRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgentV2" } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{id}/runs_overview/": { "get": { "operationId": "aiagents-v1-runs-overview-retrieve", "description": "Aiagents v1 runs overview", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgent" } } }, "description": "" } } } }, "/test_framework/v1/aiagents/{id}/upload_knowledge_base/": { "post": { "operationId": "aiagents-upload-knowledge-base", "description": "Upload one or more files to the agent's knowledge base. Accepts either a `multipart/form-data` body (used by the web dashboard) or an `application/json` body where each entry carries base64-encoded file content.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai agent.", "required": true }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "test_framework" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "List of files to upload to the knowledge base" } }, "required": [ "files" ] } }, "application/json": { "schema": { "type": "object", "properties": { "files": { "type": "array", "description": "List of files to upload, each provided as base64-encoded content.", "items": { "type": "object", "required": [ "name", "content_base64" ], "properties": { "name": { "type": "string", "description": "Filename including extension (e.g. `manual.pdf`)." }, "content_base64": { "type": "string", "contentEncoding": "base64", "description": "Base64-encoded file content. Accepts a raw base64 string or a `data:;base64,...` data URI." } } } } }, "required": [ "files" ] } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedKnowledgeBaseFileList" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/aiagents/runs_overview_project/": { "get": { "operationId": "aiagents-v1-runs-overview-project-retrieve", "description": "Aiagents v1 runs overview project", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIAgent" } } }, "description": "" } } } }, "/test_framework/v1/aiagents/short_list/": { "get": { "operationId": "aiagents-v1-short-list-list", "description": "Aiagents v1 short list", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "Filter agents by project ID" }, { "in": "query", "name": "organization_id", "schema": { "type": "integer" }, "description": "Filter agents by organization ID" }, { "in": "query", "name": "q", "schema": { "type": "string" }, "description": "Search agents by name. A numeric value also matches the agent id." } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAIAgentListList" } } }, "description": "" } } } }, "/test_framework/v1/configurations/": { "get": { "operationId": "configurations-list", "description": "List per-user configurations", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "test_framework" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserConfigurationList" } } }, "description": "" } } }, "post": { "operationId": "configurations-create", "description": "Create a new per-user configuration", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserConfiguration" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UserConfiguration" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UserConfiguration" } } }, "required": true }, "security": [ { "supabase_session": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserConfiguration" } } }, "description": "" } } } }, "/test_framework/v1/configurations/{id}/": { "get": { "operationId": "configurations-retrieve", "description": "Retrieve a per-user configuration by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user configuration.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserConfiguration" } } }, "description": "" } } }, "put": { "operationId": "configurations-update", "description": "Update a per-user configuration", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user configuration.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserConfiguration" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UserConfiguration" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UserConfiguration" } } }, "required": true }, "security": [ { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserConfiguration" } } }, "description": "" } } }, "patch": { "operationId": "configurations-partial-update", "description": "Update a per-user configuration", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user configuration.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedUserConfiguration" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedUserConfiguration" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedUserConfiguration" } } } }, "security": [ { "supabase_session": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserConfiguration" } } }, "description": "" } } }, "delete": { "operationId": "configurations-destroy", "description": "Delete a per-user configuration", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user configuration.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "supabase_session": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/critical-metric-categories-external/": { "get": { "operationId": "critical-metric-categories-external-list", "description": "List External API view set", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "test_framework" ], "security": [ { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCriticalMetricCategoryList" } } }, "description": "" } } }, "post": { "operationId": "critical-metric-categories-external-create", "description": "Create a new External API view set", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } } } }, "security": [ { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } } }, "description": "" } } } }, "/test_framework/v1/critical-metric-categories-external/{id}/": { "get": { "operationId": "critical-metric-categories-external-retrieve", "description": "Retrieve an External API view set by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "security": [ { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } } }, "description": "" } } }, "put": { "operationId": "critical-metric-categories-external-update", "description": "Update an External API view set", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } } } }, "security": [ { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } } }, "description": "" } } }, "patch": { "operationId": "critical-metric-categories-external-partial-update", "description": "Update an External API view set", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCriticalMetricCategory" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCriticalMetricCategory" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCriticalMetricCategory" } } } }, "security": [ { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricCategory" } } }, "description": "" } } }, "delete": { "operationId": "critical-metric-categories-external-destroy", "description": "Delete an External API view set", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "security": [ { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/critical-metric-scenarios/": { "get": { "operationId": "critical-metric-scenarios-list", "description": "List critical metric scenarios", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "agent_id", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `agent_id`, `category_id`, `metric_id` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." }, { "name": "category_id", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `agent_id`, `category_id`, `metric_id` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." }, { "name": "metric_id", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `agent_id`, `category_id`, `metric_id` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCriticalMetricScenarioList" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "List critical metric scenarios", "x-mcp-summary-derived": true, "x-mint": { "mcp": { "enabled": true, "name": "critical-metric-scenarios-list", "description": "List critical metric scenarios" } } } }, "/test_framework/v1/critical-metric-scenarios-external/": { "get": { "operationId": "critical-metric-scenarios-external-list", "description": "List scenarios flagged by critical metrics", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCriticalMetricScenarioList" } } }, "description": "" } } } }, "/test_framework/v1/critical-metric-scenarios-external/{id}/": { "get": { "operationId": "critical-metric-scenarios-external-retrieve", "description": "Retrieve a critical metric scenario by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this critical metric scenario.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricScenario" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } }, "put": { "operationId": "critical-metric-scenarios-external-update", "description": "Update a critical metric scenario", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this critical metric scenario.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricScenario" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CriticalMetricScenario" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CriticalMetricScenario" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricScenario" } } }, "description": "" } } }, "patch": { "operationId": "critical-metric-scenarios-external-partial-update", "description": "Update a critical metric scenario flag", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this critical metric scenario.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedRequestCriticalMetricScenario" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedRequestCriticalMetricScenario" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedRequestCriticalMetricScenario" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricScenario" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/critical-metric-scenarios/{id}/": { "get": { "operationId": "critical-metric-scenarios-retrieve", "description": "Retrieve a critical metric scenario by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this critical metric scenario.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricScenario" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } }, "put": { "operationId": "critical-metric-scenarios-update", "description": "Update a critical metric scenario", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this critical metric scenario.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricScenario" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CriticalMetricScenario" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CriticalMetricScenario" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricScenario" } } }, "description": "" } } }, "patch": { "operationId": "critical-metric-scenarios-partial-update", "description": "Update a critical metric scenario", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this critical metric scenario.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedRequestCriticalMetricScenario" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedRequestCriticalMetricScenario" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedRequestCriticalMetricScenario" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriticalMetricScenario" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Update a critical metric scenario", "x-mint": { "mcp": { "enabled": true, "name": "critical-metric-scenarios-partial-update", "description": "Update a critical metric scenario" } } } }, "/test_framework/v1/email-inbound/": { "post": { "operationId": "email-inbound-create", "tags": [ "test_framework" ], "responses": { "200": { "description": "No response body" } }, "description": "Create a new email inbound" } }, "/test_framework/v1/knowledge-base-connectors/": { "get": { "operationId": "knowledge-base-connectors-list", "description": "List BigQuery knowledge base connectors attached to AI agents", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseConnectorList" } } } }, "description": "" } } }, "post": { "operationId": "knowledge-base-connectors-create", "description": "Create a new BigQuery knowledge base connectors attached to AI agent", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } } }, "description": "" } } } }, "/test_framework/v1/knowledge-base-connectors/{id}/": { "get": { "operationId": "knowledge-base-connectors-retrieve", "description": "Retrieve a BigQuery knowledge base connectors attached to AI agent by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base connector.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } } }, "description": "" } } }, "put": { "operationId": "knowledge-base-connectors-update", "description": "Update a BigQuery knowledge base connectors attached to AI agent", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base connector.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } } }, "description": "" } } }, "patch": { "operationId": "knowledge-base-connectors-partial-update", "description": "Update a BigQuery knowledge base connectors attached to AI agent", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base connector.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedKnowledgeBaseConnector" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedKnowledgeBaseConnector" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedKnowledgeBaseConnector" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } } }, "description": "" } } }, "delete": { "operationId": "knowledge-base-connectors-destroy", "description": "Delete a BigQuery knowledge base connectors attached to AI agent", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base connector.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/knowledge-base-connectors/{id}/sync/": { "post": { "operationId": "knowledge-base-connectors-sync-create", "description": "Trigger an immediate sync for this connector.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base connector.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseConnector" } } }, "description": "" } } } }, "/test_framework/v1/livekit-webhook/": { "post": { "operationId": "livekit-webhook-create", "description": "Handle incoming LiveKit webhook POST requests.", "tags": [ "test_framework" ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/test_framework/v1/metrics/": { "get": { "operationId": "metrics-v1-list", "description": "\nmetrics_list: List quality metrics (LLM-judge prompts, custom code, or predefined metrics) used to evaluate AI voice agents. Filter by `agent_id` or `project_id` to scope results.\n\nFiltering behavior:\n- If only agent_id is provided: Returns metrics associated with that agent only\n- If only project_id is provided: Returns metrics associated with that project only\n- If both agent_id and project_id are provided: Returns metrics from both the agent and the project\n- If agents is provided: Returns metrics where any of the specified agents are in the M2M agents field\n- If slug is provided: Returns the metric with that specific slug\n\nPerformance tip: `agent_id` (when a specific agent is in context) or `project_id` will narrow the result. Orgs can accumulate hundreds of metrics so a filter usually helps.\n ", "summary": "List metrics", "parameters": [ { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "\nFilter by agent ID\nExample: `123`\n" }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "\nFilter by project ID\nExample: `456`\n" }, { "in": "query", "name": "assistant_id", "schema": { "type": "string" }, "description": "\nFilter by assistant ID\nExample: `asst_1234567890`\n" }, { "in": "query", "name": "agents", "schema": { "type": "string" }, "description": "\nFilter metrics by agent IDs. Supports comma-separated list.\nExample: `1,2,3` to filter metrics associated with any of these agents\n" }, { "in": "query", "name": "slug", "schema": { "type": "string" }, "description": "\nFilter by metric slug\nExample: `latency_metric` or `customer_satisfaction`\n" }, { "in": "query", "name": "filters", "schema": { "type": "object" }, "description": "JSON filter parameter for advanced filtering.\n\nExample:\n```json\n{\"operator\":\"and\",\"conditions\":[{\"field\":\"agents__id\",\"op\":\"in\",\"value\":[1,2,3]}]}\n```\n\nSupported fields: agents__id, eval_type, type, name\nSupported operators: in, eq, contains" }, { "in": "query", "name": "include_scores", "schema": { "type": "boolean" }, "description": "\nInclude Overall and Total scores in Metric List\nExample: `true` or `false`\n " } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetricList" } }, "examples": { "MetricList": { "value": [ { "id": 123, "name": "", "description": "", "function_name": "", "type": "basic", "eval_type": "binary", "enum_values": [ "" ], "audio_enabled": true, "observability_enabled": true, "simulation_enabled": true, "prompt": "", "evaluation_trigger": "always", "evaluation_trigger_prompt": "", "priority_assignment_prompt": "", "vocera_defined_metric_code": "", "configuration": { "infra_issues_timeout": "", "key": "value" }, "kb_file_ids": [ "" ], "knowledge_base_files": [ { "id": "", "agent": "", "file_url": "", "file_name": "", "file_type": "", "file_size": "", "created_at": "", "updated_at": "" } ], "metric_cost": "" } ] }, "MetricListWithOverallScore": { "value": [ { "id": "", "name": "", "description": "", "function_name": "", "type": "basic", "eval_type": "binary", "enum_values": [ "" ], "audio_enabled": true, "observability_enabled": true, "simulation_enabled": true, "prompt": "", "evaluation_trigger": "always", "evaluation_trigger_prompt": "", "priority_assignment_prompt": "", "vocera_defined_metric_code": "", "configuration": { "infra_issues_timeout": "", "key": "value" }, "kb_file_ids": [ "" ], "knowledge_base_files": [ { "id": "", "agent": "", "file_url": "", "file_name": "", "file_type": "", "file_size": "", "created_at": "", "updated_at": "" } ], "metric_cost": "", "overall_score": "", "total_score": "" } ] } } } }, "description": "" } } }, "post": { "operationId": "metrics-v1-create", "description": "Create a quality metric for evaluating agent conversations.\n\n**Two supported types on create** (the `BASIC` and `CUSTOM_PROMPT` values are deprecated and rejected on create):\n\n- `llm_judge` — an LLM-as-judge metric. Put the evaluation criterion in `description`. Most common choice for qualitative scoring (politeness, compliance, resolution quality, etc.).\n\n- `custom_code` — Python code that receives the transcript and returns a score. Put the code in `custom_code`. Use for deterministic checks (regex matches, tool-call ordering, structured-field extraction, etc.).\n\n**Scope:** metrics must be created at the project level — pass `project` (project ID). Agent-level metrics are deprecated; if you pass `agent`, the server silently creates a project-level metric and returns a deprecation warning.\n\n**Evaluation control:** `observability_enabled` runs the metric on production calls (via CallLog); `simulation_enabled` runs it on test runs; `sampling_enabled` enables statistical sampling. `eval_type` picks the output shape (`bool`, `int`, `float`, `enum`, `string`); when `eval_type=\"enum\"`, also pass `enum_values`.\n\n**Triggering:** pass `trigger_type` + `evaluation_trigger_prompt` to gate the metric to only fire on specific call patterns (see the metric-triggers guide).", "summary": "Create a metric", "tags": [ "Metrics" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" }, "examples": { "LLMJudgeMetric(simplest—MostCommon)": { "value": { "project": 1376, "name": "Was the caller greeted by name", "description": "Score TRUE if the agent addressed the caller by their name within the first 3 turns, FALSE otherwise.", "type": "llm_judge", "eval_type": "bool", "simulation_enabled": true, "observability_enabled": true }, "summary": "LLM judge metric (simplest — most common)" }, "LLMJudge—EnumOutput": { "value": { "project": 1376, "name": "Call resolution outcome", "description": "Classify how the call ended: `resolved` (caller's issue was fully addressed), `transferred` (caller was handed off to a human), `dropped` (caller hung up without resolution).", "type": "llm_judge", "eval_type": "enum", "enum_values": [ "resolved", "transferred", "dropped" ], "observability_enabled": true }, "summary": "LLM judge — enum output" }, "CustomCodeMetric(deterministicCheck)": { "value": { "project": 1376, "name": "Agent asked for order ID before refund", "type": "custom_code", "eval_type": "bool", "custom_code": "def score(transcript, context):\n text = transcript.lower()\n return 'order id' in text[:text.find('refund')] if 'refund' in text else True\n", "simulation_enabled": true }, "summary": "Custom code metric (deterministic check)" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/": { "get": { "operationId": "metrics-v1-external-list", "description": "\nmetrics_list: List quality metrics (LLM-judge prompts, custom code, or predefined metrics) used to evaluate AI voice agents. Filter by `agent_id` or `project_id` to scope results.\n\nFiltering behavior:\n- If only agent_id is provided: Returns metrics associated with that agent only\n- If only project_id is provided: Returns metrics associated with that project only\n- If both agent_id and project_id are provided: Returns metrics from both the agent and the project\n- If agents is provided: Returns metrics where any of the specified agents are in the M2M agents field\n- If slug is provided: Returns the metric with that specific slug\n\nPerformance tip: `agent_id` (when a specific agent is in context) or `project_id` will narrow the result. Orgs can accumulate hundreds of metrics so a filter usually helps.\n ", "summary": "List metrics", "parameters": [ { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "\nFilter by agent ID\nExample: `123`\n" }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "\nFilter by project ID\nExample: `456`\n" }, { "in": "query", "name": "assistant_id", "schema": { "type": "string" }, "description": "\nFilter by assistant ID\nExample: `asst_1234567890`\n" }, { "in": "query", "name": "agents", "schema": { "type": "string" }, "description": "\nFilter metrics by agent IDs. Supports comma-separated list.\nExample: `1,2,3` to filter metrics associated with any of these agents\n" }, { "in": "query", "name": "slug", "schema": { "type": "string" }, "description": "\nFilter by metric slug\nExample: `latency_metric` or `customer_satisfaction`\n" }, { "in": "query", "name": "filters", "schema": { "type": "object" }, "description": "JSON filter parameter for advanced filtering.\n\nExample:\n```json\n{\"operator\":\"and\",\"conditions\":[{\"field\":\"agents__id\",\"op\":\"in\",\"value\":[1,2,3]}]}\n```\n\nSupported fields: agents__id, eval_type, type, name\nSupported operators: in, eq, contains" }, { "in": "query", "name": "include_scores", "schema": { "type": "boolean" }, "description": "\nInclude Overall and Total scores in Metric List\nExample: `true` or `false`\n " } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetricList" } }, "examples": { "MetricList": { "value": [ { "id": 123, "name": "", "description": "", "function_name": "", "type": "basic", "eval_type": "binary", "enum_values": [ "" ], "audio_enabled": true, "observability_enabled": true, "simulation_enabled": true, "prompt": "", "evaluation_trigger": "always", "evaluation_trigger_prompt": "", "priority_assignment_prompt": "", "vocera_defined_metric_code": "", "configuration": { "infra_issues_timeout": "", "key": "value" }, "kb_file_ids": [ "" ], "knowledge_base_files": [ { "id": "", "agent": "", "file_url": "", "file_name": "", "file_type": "", "file_size": "", "created_at": "", "updated_at": "" } ], "metric_cost": "" } ] }, "MetricListWithOverallScore": { "value": [ { "id": "", "name": "", "description": "", "function_name": "", "type": "basic", "eval_type": "binary", "enum_values": [ "" ], "audio_enabled": true, "observability_enabled": true, "simulation_enabled": true, "prompt": "", "evaluation_trigger": "always", "evaluation_trigger_prompt": "", "priority_assignment_prompt": "", "vocera_defined_metric_code": "", "configuration": { "infra_issues_timeout": "", "key": "value" }, "kb_file_ids": [ "" ], "knowledge_base_files": [ { "id": "", "agent": "", "file_url": "", "file_name": "", "file_type": "", "file_size": "", "created_at": "", "updated_at": "" } ], "metric_cost": "", "overall_score": "", "total_score": "" } ] } } } }, "description": "" } } }, "post": { "operationId": "metrics-v1-external-create", "description": "Create a quality metric for evaluating agent conversations.\n\n**Two supported types on create** (the `BASIC` and `CUSTOM_PROMPT` values are deprecated and rejected on create):\n\n- `llm_judge` — an LLM-as-judge metric. Put the evaluation criterion in `description`. Most common choice for qualitative scoring (politeness, compliance, resolution quality, etc.).\n\n- `custom_code` — Python code that receives the transcript and returns a score. Put the code in `custom_code`. Use for deterministic checks (regex matches, tool-call ordering, structured-field extraction, etc.).\n\n**Scope:** metrics must be created at the project level — pass `project` (project ID). Agent-level metrics are deprecated; if you pass `agent`, the server silently creates a project-level metric and returns a deprecation warning.\n\n**Evaluation control:** `observability_enabled` runs the metric on production calls (via CallLog); `simulation_enabled` runs it on test runs; `sampling_enabled` enables statistical sampling. `eval_type` picks the output shape (`bool`, `int`, `float`, `enum`, `string`); when `eval_type=\"enum\"`, also pass `enum_values`.\n\n**Triggering:** pass `trigger_type` + `evaluation_trigger_prompt` to gate the metric to only fire on specific call patterns (see the metric-triggers guide).", "summary": "Create a metric", "tags": [ "Metrics" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" }, "examples": { "LLMJudgeMetric(simplest—MostCommon)": { "value": { "project": 1376, "name": "Was the caller greeted by name", "description": "Score TRUE if the agent addressed the caller by their name within the first 3 turns, FALSE otherwise.", "type": "llm_judge", "eval_type": "bool", "simulation_enabled": true, "observability_enabled": true }, "summary": "LLM judge metric (simplest — most common)" }, "LLMJudge—EnumOutput": { "value": { "project": 1376, "name": "Call resolution outcome", "description": "Classify how the call ended: `resolved` (caller's issue was fully addressed), `transferred` (caller was handed off to a human), `dropped` (caller hung up without resolution).", "type": "llm_judge", "eval_type": "enum", "enum_values": [ "resolved", "transferred", "dropped" ], "observability_enabled": true }, "summary": "LLM judge — enum output" }, "CustomCodeMetric(deterministicCheck)": { "value": { "project": 1376, "name": "Agent asked for order ID before refund", "type": "custom_code", "eval_type": "bool", "custom_code": "def score(transcript, context):\n text = transcript.lower()\n return 'order id' in text[:text.find('refund')] if 'refund' in text else True\n", "simulation_enabled": true }, "summary": "Custom code metric (deterministic check)" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/{id}/": { "get": { "operationId": "metrics-v1-external-retrieve", "description": "Retrieve a specific metric by ID or slug.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "description": "**ID or Slug** - Metric identifier. Can be either:\n- Numeric ID (e.g., `123`)\n- Slug (e.g., `latency_metric`, `customer_satisfaction`)", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } }, "put": { "operationId": "metrics-v1-external-update", "description": "Update a metric (full)", "summary": "Update a metric (full)", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "Metrics" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } }, "patch": { "operationId": "metrics-v1-external-partial-update", "description": "Partially update a metric. Same field shape as create — see `metrics_create` for details.\n\n**Note:** `project`, `agent`, and `audio_enabled` are read-only once set. To change `audio_enabled` on an existing metric, create a new metric with the desired setting and delete the old one.", "summary": "Update a metric (partial)", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "Metrics" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostMetricEdit" }, "examples": { "UpdatePrompt+CriticalFlag": { "value": { "description": "Updated rubric", "is_critical": true }, "summary": "Update prompt + critical flag" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostMetricEdit" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostMetricEdit" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } }, "delete": { "operationId": "metrics-v1-external-destroy", "description": "⚠ Irreversible. Deletes the metric and detaches it from all agents and evaluators. Dashboard widgets that displayed this metric are also removed.", "summary": "Delete a metric", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/{id}/add_to_predefined_metrics/": { "post": { "operationId": "metrics-v1-external-add-to-predefined-metrics-create", "description": "Metrics v1 add to predefined metrics", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/{id}/apply_optimisation_proposal/": { "post": { "operationId": "metrics-v1-external-apply-optimisation-proposal-create", "description": "Apply a pending optimisation proposal", "summary": "Apply a pending optimisation proposal", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Metric updated; pending proposal cleared." } } } }, "/test_framework/v1/metrics-external/{id}/dismiss_optimisation_proposal/": { "post": { "operationId": "metrics-v1-external-dismiss-optimisation-proposal-create", "description": "Dismiss a pending optimisation proposal", "summary": "Dismiss a pending optimisation proposal", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Proposal cleared." } } } }, "/test_framework/v1/metrics-external/{id}/evaluate_advance_metric/": { "post": { "operationId": "metrics-v1-external-evaluate-advance-metric-create", "description": "Evaluate an advance metric in the background.\n\nReturns a progress_id to poll for results.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "lambda_token": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/{id}/evaluate_basic_metric/": { "post": { "operationId": "metrics-v1-external-evaluate-basic-metric-create", "description": "Evaluate a basic metric in the background.\n\nReturns a progress_id to poll for results.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "lambda_token": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/{id}/evaluate_llm_judge_metric/": { "post": { "operationId": "metrics-v1-external-evaluate-llm-judge-metric-create", "description": "Evaluate a metric using LLM Judge (DSPy) in the background.\n\nReturns a progress_id to poll for results.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateLlmJudgeMetricRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EvaluateLlmJudgeMetricRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/EvaluateLlmJudgeMetricRequest" } } }, "required": true }, "security": [ { "lambda_token": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateLlmJudgeMetricResponse" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/{id}/history/": { "get": { "operationId": "metrics-v1-external-history-list", "description": "Metrics v1 history", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "page_size", "schema": { "type": "integer" } } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedMetricHistoryList" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/{id}/history/edit/": { "patch": { "operationId": "metrics-v1-external-history-edit-partial-update", "description": "Metrics v1 history edit", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedMetricEditHistoryRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedMetricEditHistoryRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedMetricEditHistoryRequest" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricHistory" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/{id}/restore/": { "post": { "operationId": "metrics-v1-external-restore-create", "description": "Metrics v1 restore", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricRestoreRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricRestoreRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricRestoreRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/{id}/run_reviews/": { "post": { "operationId": "metrics-v1-external-run-reviews-create", "description": "Metrics v1 run reviews", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunReviewsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RunReviewsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RunReviewsRequest" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns progress_id for tracking progress" } } } }, "/test_framework/v1/metrics-external/{id}/variables/": { "post": { "operationId": "metrics-v1-external-variables-create", "description": "Get all variables and their values for a specific test_set and metric combination.\n\nURL Parameter:\n- pk: The metric_id\n\nRequest Body:\n- test_set_id (required): The ID of the test_set (datapoint)\n- metric_description_variables (required/optional): Array of variable names for description.\n At least one of metric_description_variables or evaluation_trigger_variables must be provided.\n- evaluation_trigger_variables (required/optional): Array of variable names for trigger.\n At least one of metric_description_variables or evaluation_trigger_variables must be provided.\n\nThis endpoint retrieves the variables and populates them with values from the test_set (datapoint).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/basic_list/": { "get": { "operationId": "metrics-v1-external-basic-list-retrieve", "description": "Metrics v1 basic list", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricBasicList" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/build-agent/": { "post": { "operationId": "metrics-v1-external-build-agent-create", "description": "Start (or continue) an agentic metric-building session. On the first call, pass `agent_id` and `description` (the natural-language metric intent); the agent cleans up the definition, runs it against a sample of the agent's calls and runs, and either asks a clarifying question or returns a refined definition. To answer a question, pass `session_id` and `user_message`. Poll build-agent-progress with the returned `progress_id`.", "summary": "Build or refine a metric via the agent chatbot", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/build-agent-cancel/": { "post": { "operationId": "metrics-v1-external-build-agent-cancel-create", "description": "Metrics v1 build agent cancel", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/build-agent-progress/": { "get": { "operationId": "metrics-v1-external-build-agent-progress-retrieve", "description": "Metrics v1 build agent progress", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/bulk-toggle-settings/": { "post": { "operationId": "metrics-v1-external-bulk-toggle-settings-create", "description": "Metrics v1 bulk toggle settings", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/bulk_create/": { "post": { "operationId": "metrics-bulk-create", "description": "Create multiple metrics in a single request", "summary": "Create multiple metrics in a single request", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "application/x-www-form-urlencoded": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "multipart/form-data": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/bulk_manage_agents/": { "post": { "operationId": "metrics-v1-external-bulk-manage-agents-create", "description": "Metrics v1 bulk manage agents", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkAgentAssignment" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BulkAgentAssignment" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BulkAgentAssignment" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkAgentAssignmentResponse" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/delete_metrics/": { "post": { "operationId": "metrics-v1-external-delete-metrics-create", "description": "Metrics v1 delete metrics", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/evaluate_metric_progress/": { "get": { "operationId": "metrics-v1-external-evaluate-metric-progress-retrieve", "description": "Poll for metric evaluation progress.\n\nQuery params:\n progress_id: The progress_id returned from evaluate_basic_metric or evaluate_advance_metric\n\nReturns:\n State object with status, output, error, etc.", "tags": [ "test_framework" ], "security": [ { "lambda_token": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/fetch_call_details/": { "get": { "operationId": "metrics-v1-external-fetch-call-details-retrieve", "description": "Metrics v1 fetch call details", "tags": [ "test_framework" ], "security": [ { "lambda_token": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/generate_clean_description/": { "post": { "operationId": "metrics-v1-external-generate-clean-description-create", "description": "Metrics v1 generate clean description", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/generate_clean_description_bg/": { "post": { "operationId": "metrics-v1-external-generate-clean-description-bg-create", "description": "Start async clean description generation", "summary": "Start async clean description generation", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CleanMetricDescriptionRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CleanMetricDescriptionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CleanMetricDescriptionRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateCleanDescriptionBgResponse" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/generate_clean_description_progress/": { "get": { "operationId": "metrics-v1-external-generate-clean-description-progress-retrieve", "description": "Poll async clean description generation", "summary": "Poll async clean description generation", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "description": "progress_id returned from generate_clean_description_bg", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateCleanDescriptionProgressResponse" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/generate_evaluation_trigger/": { "post": { "operationId": "metrics-v1-external-generate-evaluation-trigger-create", "description": "Metrics v1 generate evaluation trigger", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/generate_metrics/": { "post": { "operationId": "metrics-generate", "description": "Generates suggested metrics for an AI agent. Returns a `progress_id` to poll via `generate_metrics_progress`. Results appear in the progress response but are not saved automatically — pass them to the metrics bulk create endpoint to persist. The agent must have a description of at least 100 characters.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaGenerateMetricsMetricCreate" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaGenerateMetricsMetricCreate" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaGenerateMetricsMetricCreate" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaGenerateMetricsResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/generate_metrics_progress/": { "get": { "operationId": "metrics-v1-external-generate-metrics-progress-retrieve", "description": "Metrics v1 generate metrics progress", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "description": "Progress ID returned from the generate_metrics endpoint", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns generation state with status and generated metrics" } } } }, "/test_framework/v1/metrics-external/preview/": { "post": { "operationId": "metrics-v1-external-preview-create", "description": "Metrics v1 preview", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricPreview" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricPreview" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricPreview" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns progress_id for tracking progress" } } } }, "/test_framework/v1/metrics-external/preview-progress/": { "get": { "operationId": "metrics-preview-progress", "description": "Metrics preview progress", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "description": "Progress ID returned from the preview endpoint", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns preview state with status and results" } } } }, "/test_framework/v1/metrics-external/run_reviews_progress/": { "get": { "operationId": "metrics-run-reviews-progress", "description": "Metrics run reviews progress", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "description": "Progress ID returned from the run_reviews endpoint", "required": true }, { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "Agent ID for permission validation" }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "Project ID for permission validation" } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns progress state with completed/failed counts and metric data when finished" } } } }, "/test_framework/v1/metrics-external/save_result/": { "post": { "operationId": "metrics-v1-external-save-result-create", "description": "Metrics v1 save result", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "lambda_token": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/simplify_prompt/": { "post": { "operationId": "metrics-v1-external-simplify-prompt-create", "description": "Metrics v1 simplify prompt", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimplifyPromptRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SimplifyPromptRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SimplifyPromptRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimplifyPromptResponse" } } }, "description": "" } } } }, "/test_framework/v1/metrics-external/simplify_prompt_progress/": { "get": { "operationId": "metrics-v1-external-simplify-prompt-progress-retrieve", "description": "Metrics v1 simplify prompt progress", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "description": "Progress ID returned from simplify_prompt endpoint", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimplifyPromptProgressResponse" } } }, "description": "" } } } }, "/test_framework/v1/metrics/{id}/": { "get": { "operationId": "metrics-v1-retrieve", "description": "Retrieve a specific metric by ID or slug.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "description": "**ID or Slug** - Metric identifier. Can be either:\n- Numeric ID (e.g., `123`)\n- Slug (e.g., `latency_metric`, `customer_satisfaction`)", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } }, "put": { "operationId": "metrics-v1-update", "description": "Update a metric (full)", "summary": "Update a metric (full)", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "Metrics" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } }, "patch": { "operationId": "metrics-v1-partial-update", "description": "Partially update a metric. Same field shape as create — see `metrics_create` for details.\n\n**Note:** `project`, `agent`, and `audio_enabled` are read-only once set. To change `audio_enabled` on an existing metric, create a new metric with the desired setting and delete the old one.", "summary": "Update a metric (partial)", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "Metrics" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostMetricEdit" }, "examples": { "UpdatePrompt+CriticalFlag": { "value": { "description": "Updated rubric", "is_critical": true }, "summary": "Update prompt + critical flag" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostMetricEdit" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostMetricEdit" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } }, "delete": { "operationId": "metrics-v1-destroy", "description": "⚠ Irreversible. Deletes the metric and detaches it from all agents and evaluators. Dashboard widgets that displayed this metric are also removed.", "summary": "Delete a metric", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/test_framework/v1/metrics/{id}/add_to_predefined_metrics/": { "post": { "operationId": "metrics-v1-add-to-predefined-metrics-create", "description": "Metrics v1 add to predefined metrics", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/{id}/apply_optimisation_proposal/": { "post": { "operationId": "metrics-v1-apply-optimisation-proposal-create", "description": "Apply a pending optimisation proposal", "summary": "Apply a pending optimisation proposal", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Metric updated; pending proposal cleared." } } } }, "/test_framework/v1/metrics/{id}/dismiss_optimisation_proposal/": { "post": { "operationId": "metrics-v1-dismiss-optimisation-proposal-create", "description": "Dismiss a pending optimisation proposal", "summary": "Dismiss a pending optimisation proposal", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Proposal cleared." } } } }, "/test_framework/v1/metrics/{id}/evaluate_advance_metric/": { "post": { "operationId": "metrics-v1-evaluate-advance-metric-create", "description": "Evaluate an advance metric in the background.\n\nReturns a progress_id to poll for results.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "lambda_token": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/{id}/evaluate_basic_metric/": { "post": { "operationId": "metrics-v1-evaluate-basic-metric-create", "description": "Evaluate a basic metric in the background.\n\nReturns a progress_id to poll for results.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "lambda_token": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/{id}/evaluate_llm_judge_metric/": { "post": { "operationId": "metrics-v1-evaluate-llm-judge-metric-create", "description": "Evaluate a metric using LLM Judge (DSPy) in the background.\n\nReturns a progress_id to poll for results.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateLlmJudgeMetricRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EvaluateLlmJudgeMetricRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/EvaluateLlmJudgeMetricRequest" } } }, "required": true }, "security": [ { "lambda_token": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateLlmJudgeMetricResponse" } } }, "description": "" } } } }, "/test_framework/v1/metrics/{id}/history/": { "get": { "operationId": "metrics-v1-history-list", "description": "Metrics v1 history", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true }, { "in": "query", "name": "page", "schema": { "type": "integer" } }, { "in": "query", "name": "page_size", "schema": { "type": "integer" } } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedMetricHistoryList" } } }, "description": "" } } } }, "/test_framework/v1/metrics/{id}/history/edit/": { "patch": { "operationId": "metrics-v1-history-edit-partial-update", "description": "Metrics v1 history edit", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedMetricEditHistoryRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedMetricEditHistoryRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedMetricEditHistoryRequest" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricHistory" } } }, "description": "" } } } }, "/test_framework/v1/metrics/{id}/restore/": { "post": { "operationId": "metrics-v1-restore-create", "description": "Metrics v1 restore", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricRestoreRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricRestoreRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricRestoreRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/{id}/run_reviews/": { "post": { "operationId": "metrics-v1-run-reviews-create", "description": "Metrics v1 run reviews", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunReviewsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RunReviewsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RunReviewsRequest" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns progress_id for tracking progress" } } } }, "/test_framework/v1/metrics/{id}/variables/": { "post": { "operationId": "metrics-v1-variables-create", "description": "Get all variables and their values for a specific test_set and metric combination.\n\nURL Parameter:\n- pk: The metric_id\n\nRequest Body:\n- test_set_id (required): The ID of the test_set (datapoint)\n- metric_description_variables (required/optional): Array of variable names for description.\n At least one of metric_description_variables or evaluation_trigger_variables must be provided.\n- evaluation_trigger_variables (required/optional): Array of variable names for trigger.\n At least one of metric_description_variables or evaluation_trigger_variables must be provided.\n\nThis endpoint retrieves the variables and populates them with values from the test_set (datapoint).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/basic_list/": { "get": { "operationId": "metrics-v1-basic-list-retrieve", "description": "Metrics v1 basic list", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricBasicList" } } }, "description": "" } } } }, "/test_framework/v1/metrics/build-agent/": { "post": { "operationId": "metrics-v1-build-agent-create", "description": "Start (or continue) an agentic metric-building session. On the first call, pass `agent_id` and `description` (the natural-language metric intent); the agent cleans up the definition, runs it against a sample of the agent's calls and runs, and either asks a clarifying question or returns a refined definition. To answer a question, pass `session_id` and `user_message`. Poll build-agent-progress with the returned `progress_id`.", "summary": "Build or refine a metric via the agent chatbot", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/build-agent-cancel/": { "post": { "operationId": "metrics-v1-build-agent-cancel-create", "description": "Metrics v1 build agent cancel", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/build-agent-progress/": { "get": { "operationId": "metrics-v1-build-agent-progress-retrieve", "description": "Metrics v1 build agent progress", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/bulk-toggle-settings/": { "post": { "operationId": "metrics-v1-bulk-toggle-settings-create", "description": "Metrics v1 bulk toggle settings", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/bulk_create/": { "post": { "operationId": "metrics-bulk-create_2", "description": "Create multiple metrics in a single request", "summary": "Create multiple metrics in a single request", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "application/x-www-form-urlencoded": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } }, "multipart/form-data": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaPostMetricEdit" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/metrics/bulk_manage_agents/": { "post": { "operationId": "metrics-v1-bulk-manage-agents-create", "description": "Metrics v1 bulk manage agents", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkAgentAssignment" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BulkAgentAssignment" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BulkAgentAssignment" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkAgentAssignmentResponse" } } }, "description": "" } } } }, "/test_framework/v1/metrics/delete_metrics/": { "post": { "operationId": "metrics-v1-delete-metrics-create", "description": "Metrics v1 delete metrics", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/evaluate_metric_progress/": { "get": { "operationId": "metrics-v1-evaluate-metric-progress-retrieve", "description": "Poll for metric evaluation progress.\n\nQuery params:\n progress_id: The progress_id returned from evaluate_basic_metric or evaluate_advance_metric\n\nReturns:\n State object with status, output, error, etc.", "tags": [ "test_framework" ], "security": [ { "lambda_token": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/fetch_call_details/": { "get": { "operationId": "metrics-v1-fetch-call-details-retrieve", "description": "Metrics v1 fetch call details", "tags": [ "test_framework" ], "security": [ { "lambda_token": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/generate_clean_description/": { "post": { "operationId": "metrics-v1-generate-clean-description-create", "description": "Metrics v1 generate clean description", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/generate_clean_description_bg/": { "post": { "operationId": "metrics-v1-generate-clean-description-bg-create", "description": "Start async clean description generation", "summary": "Start async clean description generation", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CleanMetricDescriptionRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CleanMetricDescriptionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CleanMetricDescriptionRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateCleanDescriptionBgResponse" } } }, "description": "" } } } }, "/test_framework/v1/metrics/generate_clean_description_progress/": { "get": { "operationId": "metrics-v1-generate-clean-description-progress-retrieve", "description": "Poll async clean description generation", "summary": "Poll async clean description generation", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "description": "progress_id returned from generate_clean_description_bg", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateCleanDescriptionProgressResponse" } } }, "description": "" } } } }, "/test_framework/v1/metrics/generate_evaluation_trigger/": { "post": { "operationId": "metrics-v1-generate-evaluation-trigger-create", "description": "Metrics v1 generate evaluation trigger", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/generate_metrics/": { "post": { "operationId": "metrics-generate_2", "description": "Generates suggested metrics for an AI agent. Returns a `progress_id` to poll via `generate_metrics_progress`. Results appear in the progress response but are not saved automatically — pass them to the metrics bulk create endpoint to persist. The agent must have a description of at least 100 characters.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaGenerateMetricsMetricCreate" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaGenerateMetricsMetricCreate" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaGenerateMetricsMetricCreate" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaGenerateMetricsResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/metrics/generate_metrics_progress/": { "get": { "operationId": "metrics-v1-generate-metrics-progress-retrieve", "description": "Metrics v1 generate metrics progress", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "description": "Progress ID returned from the generate_metrics endpoint", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns generation state with status and generated metrics" } } } }, "/test_framework/v1/metrics/preview/": { "post": { "operationId": "metrics-v1-preview-create", "description": "Metrics v1 preview", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricPreview" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricPreview" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricPreview" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns progress_id for tracking progress" } } } }, "/test_framework/v1/metrics/preview-progress/": { "get": { "operationId": "metrics-preview-progress_2", "description": "Metrics preview progress", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "description": "Progress ID returned from the preview endpoint", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns preview state with status and results" } } } }, "/test_framework/v1/metrics/run_reviews_progress/": { "get": { "operationId": "metrics-run-reviews-progress_2", "description": "Metrics run reviews progress", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "description": "Progress ID returned from the run_reviews endpoint", "required": true }, { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "Agent ID for permission validation" }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "Project ID for permission validation" } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "Returns progress state with completed/failed counts and metric data when finished" } } } }, "/test_framework/v1/metrics/save_result/": { "post": { "operationId": "metrics-v1-save-result-create", "description": "Metrics v1 save result", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "required": true }, "security": [ { "lambda_token": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricDetailV2" } } }, "description": "" } } } }, "/test_framework/v1/metrics/simplify_prompt/": { "post": { "operationId": "metrics-v1-simplify-prompt-create", "description": "Metrics v1 simplify prompt", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimplifyPromptRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SimplifyPromptRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SimplifyPromptRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimplifyPromptResponse" } } }, "description": "" } } } }, "/test_framework/v1/metrics/simplify_prompt_progress/": { "get": { "operationId": "metrics-v1-simplify-prompt-progress-retrieve", "description": "Metrics v1 simplify prompt progress", "parameters": [ { "in": "query", "name": "progress_id", "schema": { "type": "string" }, "description": "Progress ID returned from simplify_prompt endpoint", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimplifyPromptProgressResponse" } } }, "description": "" } } } }, "/test_framework/v1/personalities/": { "get": { "operationId": "personalities-list", "description": "List personalities available for use in your evaluators.\n\nReturns personalities owned by your organization plus globally available personalities.\n\n**Filters:**\n- `language` — filter by language code (e.g. `en`, `es`)\n- `project_id` — filter to personalities owned by a specific project\n\n**Using personality IDs in evaluators:** globally available personalities (those with no project or organization owner) work across all projects. Organization-specific personalities are only usable within their own organization.\n\nPerformance tip: this endpoint can return large payloads. When you know the language of the agent in scope, try passing `language` (e.g. `en`, `es`) to narrow the result. Passing `project_id` from your workspace context also helps when you only need scoped personalities. If you genuinely need every personality, you can omit filters.", "parameters": [ { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "Filter by language code (e.g. `en`, `es`, `fr`)." }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "Filter by project ID" } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatePersonality" } } } }, "description": "" } }, "x-mcp-expose": true, "summary": "List personalities", "x-mcp-summary-derived": true, "x-mint": { "mcp": { "enabled": true, "name": "personalities-list", "description": "List personalities available for use in your evaluators.\n\nReturns personalities owned by your organization plus globally available personalities.\n\n**Filters:**\n- `language` — filter by language code (e.g. `en`, `es`)\n- `project_id` — filter to personalities owned by a specific project\n\n**Using personality IDs in evaluators:** globally available personalities (those with no project or organization owner) work across all projects. Organization-specific personalities are only usable within their own organization.\n\nPerformance tip: this endpoint can return large payloads. When you know the language of the agent in scope, try passing `language` (e.g. `en`, `es`) to narrow the result. Passing `project_id` from your workspace context also helps when you only need scoped personalities. If you genuinely need every personality, you can omit filters." } } }, "post": { "operationId": "personalities-create", "description": "Create a personality", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Create a personality", "x-mint": { "mcp": { "enabled": true, "name": "personalities-create", "description": "Create a personality" } } } }, "/test_framework/v1/personalities-external/": { "get": { "operationId": "personalities-external-list", "description": "List personalities available for use in your evaluators.\n\nReturns personalities owned by your organization plus globally available personalities.\n\n**Filters:**\n- `language` — filter by language code (e.g. `en`, `es`)\n- `project_id` — filter to personalities owned by a specific project\n\n**Using personality IDs in evaluators:** globally available personalities (those with no project or organization owner) work across all projects. Organization-specific personalities are only usable within their own organization.\n\nPerformance tip: this endpoint can return large payloads. When you know the language of the agent in scope, try passing `language` (e.g. `en`, `es`) to narrow the result. Passing `project_id` from your workspace context also helps when you only need scoped personalities. If you genuinely need every personality, you can omit filters.", "parameters": [ { "in": "query", "name": "language", "schema": { "type": "string" }, "description": "Filter by language code (e.g. `en`, `es`, `fr`)." }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "Filter by project ID" } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreatePersonality" } } } }, "description": "" } } }, "post": { "operationId": "personalities-external-create", "description": "Create a new caller personality", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } } }, "/test_framework/v1/personalities-external/{id}/": { "get": { "operationId": "personalities-external-retrieve", "description": "Retrieve a caller personality by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } }, "put": { "operationId": "personalities-external-update", "description": "Update a caller personality", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } }, "patch": { "operationId": "personalities-external-partial-update", "description": "Update a caller personality", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCreatePersonality" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCreatePersonality" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCreatePersonality" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } }, "delete": { "operationId": "personalities-external-destroy", "description": "Delete a caller personality", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/personalities-external/{id}/call/": { "post": { "operationId": "personalities-external-call-create", "description": "Initiate a WebRTC call to talk to a personality directly from the browser.\nOnly callable via Bearer token (Supabase) authentication - not API keys.\nInitiates a WebRTC call via Cekura's voice service and returns Daily.co credentials.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } } }, "/test_framework/v1/personalities-external/{id}/duplicate/": { "post": { "operationId": "personalities-external-duplicate-create", "description": "Personalities duplicate", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } } }, "/test_framework/v1/personalities-external/{id}/fork/": { "post": { "operationId": "personalities-external-fork-create", "description": "Personalities fork", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } } }, "/test_framework/v1/personalities-external/cartesia_voice_preview/": { "get": { "operationId": "personalities-external-cartesia-voice-preview-retrieve", "description": "Stream a Cartesia voice's preview audio file.\n\nCartesia preview URLs require an API key; we proxy them so the browser\nnever sees the key. Bytes are cached server-side per voice_id so repeat\nplays don't re-hit Cartesia.", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } } }, "/test_framework/v1/personalities-external/cartesia_voices/": { "get": { "operationId": "personalities-external-cartesia-voices-retrieve", "description": "Get the public Cartesia voice catalog with preview audio URLs.\nOptionally filter by language.", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } } }, "/test_framework/v1/personalities-external/elevenlabs_voices/": { "get": { "operationId": "personalities-external-elevenlabs-voices-retrieve", "description": "Get available voices from ElevenLabs.\nOptionally filter by language.", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } } }, "/test_framework/v1/personalities/{id}/": { "get": { "operationId": "personalities-retrieve", "description": "Retrieve a caller personality by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } }, "put": { "operationId": "personalities-update", "description": "Update a caller personality", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } }, "patch": { "operationId": "personalities-partial-update", "description": "Update a caller personality", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCreatePersonality" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCreatePersonality" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCreatePersonality" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } }, "delete": { "operationId": "personalities-destroy", "description": "Delete a caller personality", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/personalities/{id}/call/": { "post": { "operationId": "personalities-call-create", "description": "Initiate a WebRTC call to talk to a personality directly from the browser.\nOnly callable via Bearer token (Supabase) authentication - not API keys.\nInitiates a WebRTC call via Cekura's voice service and returns Daily.co credentials.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } } }, "/test_framework/v1/personalities/{id}/duplicate/": { "post": { "operationId": "personalities-duplicate-create", "description": "Personalities duplicate", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } } }, "/test_framework/v1/personalities/{id}/fork/": { "post": { "operationId": "personalities-fork-create", "description": "Personalities fork", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personality.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } } }, "/test_framework/v1/personalities/cartesia_voice_preview/": { "get": { "operationId": "personalities-cartesia-voice-preview-retrieve", "description": "Stream a Cartesia voice's preview audio file.\n\nCartesia preview URLs require an API key; we proxy them so the browser\nnever sees the key. Bytes are cached server-side per voice_id so repeat\nplays don't re-hit Cartesia.", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } } }, "/test_framework/v1/personalities/cartesia_voices/": { "get": { "operationId": "personalities-cartesia-voices-retrieve", "description": "Get the public Cartesia voice catalog with preview audio URLs.\nOptionally filter by language.", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } } }, "/test_framework/v1/personalities/elevenlabs_voices/": { "get": { "operationId": "personalities-elevenlabs-voices-retrieve", "description": "Get available voices from ElevenLabs.\nOptionally filter by language.", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonality" } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers/": { "get": { "operationId": "phone-numbers-list", "description": "List phone numbers", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumber" } } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers-external/": { "get": { "operationId": "phone-numbers-external-list", "description": "List phone numbers", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumber" } } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers-external/{id}/": { "get": { "operationId": "phone-numbers-external-retrieve", "description": "Retrieve a phone number by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this phone number.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumber" } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers-external/check_occupancy/": { "get": { "operationId": "phone-numbers-external-check-occupancy-retrieve", "description": "Check if a phone number is currently occupied by pending runs.\n\nA phone number is considered occupied when there are runs with PENDING status\nusing that phone number. This typically happens during outbound calls when\nthe phone is being configured or a call is being initiated.\n\nQuery Parameters:\n phone_number (str): The phone number to check (e.g., +1234567890)\n\nReturns:\n 200: {\n 'phone_number': str,\n 'is_occupied': bool,\n 'message': str,\n 'pending_runs_count': int (optional, only if occupied)\n }\n 400: {'detail': str} - If phone_number parameter is missing", "parameters": [ { "in": "query", "name": "phone_number", "schema": { "type": "string" }, "description": "Phone number to check (e.g., +1234567890)", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "Success-PhoneAvailable": { "value": { "phone_number": "+1234567890", "is_occupied": false, "message": "Phone number is available" }, "summary": "Success - Phone Available" }, "Success-PhoneOccupied": { "value": { "phone_number": "+1234567890", "is_occupied": true, "message": "Phone number is currently occupied by another run", "pending_runs_count": 3 }, "summary": "Success - Phone Occupied" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers-external/inbound/": { "get": { "operationId": "phone-numbers-external-inbound-list", "description": "Phone numbers inbound", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumberInbound" } } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers/{id}/": { "get": { "operationId": "phone-numbers-retrieve", "description": "Retrieve a phone number by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this phone number.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumber" } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers/check_occupancy/": { "get": { "operationId": "phone-numbers-check-occupancy-retrieve", "description": "Check if a phone number is currently occupied by pending runs.\n\nA phone number is considered occupied when there are runs with PENDING status\nusing that phone number. This typically happens during outbound calls when\nthe phone is being configured or a call is being initiated.\n\nQuery Parameters:\n phone_number (str): The phone number to check (e.g., +1234567890)\n\nReturns:\n 200: {\n 'phone_number': str,\n 'is_occupied': bool,\n 'message': str,\n 'pending_runs_count': int (optional, only if occupied)\n }\n 400: {'detail': str} - If phone_number parameter is missing", "parameters": [ { "in": "query", "name": "phone_number", "schema": { "type": "string" }, "description": "Phone number to check (e.g., +1234567890)", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "Success-PhoneAvailable": { "value": { "phone_number": "+1234567890", "is_occupied": false, "message": "Phone number is available" }, "summary": "Success - Phone Available" }, "Success-PhoneOccupied": { "value": { "phone_number": "+1234567890", "is_occupied": true, "message": "Phone number is currently occupied by another run", "pending_runs_count": 3 }, "summary": "Success - Phone Occupied" } } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers/inbound/": { "get": { "operationId": "phone-numbers-inbound-list", "description": "List inbound phone numbers", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumberInbound" } } } }, "description": "" } }, "x-mcp-expose": true, "summary": "List inbound phone numbers", "x-mint": { "mcp": { "enabled": true, "name": "phone-numbers-inbound-list", "description": "List inbound phone numbers" } }, "parameters": [ { "name": "organization_id", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `organization_id` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ] } }, "/test_framework/v1/phone-numbers/providers/{id}/": { "delete": { "operationId": "phone-numbers-providers-destroy", "description": "Unified API viewset for BYOP (Bring Your Own Telephony Provider).\n\nHandles importing and managing phone numbers from various providers:\n- Twilio\n- Future: Vonage, Bandwidth, Telnyx, etc.\n\nURL Structure: /v1/phone-numbers/providers/{provider}/{action}\n\nHow to add a new provider:\n1. Add provider to PhoneNumberProviderChoices enum\n2. Create {Provider}Service class (e.g., VonageService)\n3. Create Import{Provider}NumberSerializer\n4. Add action method with @action(url_path=\"{provider}/import\")\n5. Update get_serializer_class() mapping", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/phone-numbers/providers/list/": { "get": { "operationId": "phone-numbers-providers-list-list", "description": "List all phone numbers for the organization.\n\nReturns all phone numbers from all providers (Cekura, Twilio, etc.)\navailable for the current organization with decrypted metadata.", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumberDetail" } } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers/providers/metadata/": { "get": { "operationId": "phone-numbers-providers-metadata-retrieve", "description": "Fetches decrypted metadata for a phone number by phone_number or id. Called by Cekura's internal voice services.", "tags": [ "test_framework" ], "security": [ { "patronus_agent_token": [] }, { "pipecat_agent_token": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberDetail" } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers/providers/plivo/bulk-import/": { "post": { "operationId": "phone-numbers-providers-plivo-bulk-import-create", "description": "Unified API viewset for BYOP (Bring Your Own Telephony Provider).\n\nHandles importing and managing phone numbers from various providers:\n- Twilio\n- Future: Vonage, Bandwidth, Telnyx, etc.\n\nURL Structure: /v1/phone-numbers/providers/{provider}/{action}\n\nHow to add a new provider:\n1. Add provider to PhoneNumberProviderChoices enum\n2. Create {Provider}Service class (e.g., VonageService)\n3. Create Import{Provider}NumberSerializer\n4. Add action method with @action(url_path=\"{provider}/import\")\n5. Update get_serializer_class() mapping", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkImportPlivoNumber" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BulkImportPlivoNumber" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BulkImportPlivoNumber" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkImportPlivoResponse" } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers/providers/plivo/import/": { "post": { "operationId": "phone-numbers-providers-plivo-import-create", "description": "Unified API viewset for BYOP (Bring Your Own Telephony Provider).\n\nHandles importing and managing phone numbers from various providers:\n- Twilio\n- Future: Vonage, Bandwidth, Telnyx, etc.\n\nURL Structure: /v1/phone-numbers/providers/{provider}/{action}\n\nHow to add a new provider:\n1. Add provider to PhoneNumberProviderChoices enum\n2. Create {Provider}Service class (e.g., VonageService)\n3. Create Import{Provider}NumberSerializer\n4. Add action method with @action(url_path=\"{provider}/import\")\n5. Update get_serializer_class() mapping", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportPlivoNumber" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ImportPlivoNumber" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ImportPlivoNumber" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberDetail" } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers/providers/telnyx/bulk-import/": { "post": { "operationId": "phone-numbers-providers-telnyx-bulk-import-create", "description": "Bulk import multiple Telnyx phone numbers.\n\nImports up to 50 phone numbers at once. Returns detailed results.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkImportTelnyxNumber" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BulkImportTelnyxNumber" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BulkImportTelnyxNumber" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkImportTelnyxResponse" } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers/providers/telnyx/import/": { "post": { "operationId": "phone-numbers-providers-telnyx-import-create", "description": "Import a Telnyx phone number to the organization.\n\nValidates Telnyx credentials, sets up webhooks, and creates PhoneNumber record.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportTelnyxNumber" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ImportTelnyxNumber" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ImportTelnyxNumber" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberDetail" } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers/providers/twilio/bulk-import/": { "post": { "operationId": "phone-numbers-providers-twilio-bulk-import-create", "description": "Bulk import multiple Twilio phone numbers.\n\nImports up to 50 phone numbers at once. Returns detailed results\nshowing which numbers succeeded and which failed.", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkImportTwilioNumber" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BulkImportTwilioNumber" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BulkImportTwilioNumber" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkImportResponse" } } }, "description": "" } } } }, "/test_framework/v1/phone-numbers/providers/twilio/import/": { "post": { "operationId": "phone-numbers-providers-twilio-import-create", "description": "Import a Twilio phone number to the organization.\n\nThis endpoint:\n1. Validates Twilio credentials\n2. Sets up webhooks on Twilio\n3. Creates PhoneNumber record with encrypted credentials", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportTwilioNumber" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ImportTwilioNumber" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ImportTwilioNumber" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberDetail" } } }, "description": "" } } } }, "/test_framework/v1/pipecat/webhook/": { "post": { "operationId": "pipecat-webhook-create", "description": "Handle incoming Pipecat webhook POST requests.", "tags": [ "test_framework" ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "No response body" } } } }, "/test_framework/v1/predefined-metrics/": { "get": { "operationId": "predefined-metrics-list", "description": "List predefined metrics", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PredefinedMetric" } } } }, "description": "" } }, "x-mcp-expose": true, "summary": "List predefined metrics", "x-mcp-summary-derived": true, "x-mint": { "mcp": { "enabled": true, "name": "predefined-metrics-list", "description": "List predefined metrics" } } }, "post": { "operationId": "predefined-metrics-create", "description": "Create a new predefined metric", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } } }, "description": "" } } } }, "/test_framework/v1/predefined-metrics-external/": { "get": { "operationId": "predefined-metrics-external-list", "description": "List predefined metrics", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PredefinedMetric" } } } }, "description": "" } } }, "post": { "operationId": "predefined-metrics-external-create", "description": "Create a new predefined metric", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } } }, "description": "" } } } }, "/test_framework/v1/predefined-metrics-external/{id}/": { "get": { "operationId": "predefined-metrics-external-retrieve", "description": "Retrieve a predefined metric by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this predefined metric.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } } }, "description": "" } } }, "put": { "operationId": "predefined-metrics-external-update", "description": "Update a predefined metric.\nOnly allowed if the metric has no organization (organization is None).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this predefined metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } } }, "description": "" } } }, "patch": { "operationId": "predefined-metrics-external-partial-update", "description": "Partially update a predefined metric.\nOnly allowed if the metric has no organization (organization is None).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this predefined metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPredefinedMetric" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPredefinedMetric" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPredefinedMetric" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } } }, "description": "" } } }, "delete": { "operationId": "predefined-metrics-external-destroy", "description": "Delete a predefined metric", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this predefined metric.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/predefined-metrics-external/copy/": { "post": { "operationId": "predefined-metrics-external-copy-create", "description": "Copy one or more predefined metrics (e.g. Voice Tone + Clarity, Latency, CSAT) into a project so they evaluate its calls. Pass `project_id` and either `predefined_metric_ids` or `metric_codes` from the predefined metrics list. Use this to add these built-in metrics — they cannot be created through the metrics create endpoint.", "summary": "Attach predefined metrics to a project", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetricCopyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PredefinedMetricCopyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PredefinedMetricCopyRequest" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetricList" } } } }, "description": "" } } } }, "/test_framework/v1/predefined-metrics/{id}/": { "get": { "operationId": "predefined-metrics-retrieve", "description": "Retrieve a predefined metric by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this predefined metric.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } } }, "description": "" } } }, "put": { "operationId": "predefined-metrics-update", "description": "Update a predefined metric.\nOnly allowed if the metric has no organization (organization is None).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this predefined metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } } }, "description": "" } } }, "patch": { "operationId": "predefined-metrics-partial-update", "description": "Partially update a predefined metric.\nOnly allowed if the metric has no organization (organization is None).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this predefined metric.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPredefinedMetric" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPredefinedMetric" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPredefinedMetric" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetric" } } }, "description": "" } } }, "delete": { "operationId": "predefined-metrics-destroy", "description": "Delete a predefined metric", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this predefined metric.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/predefined-metrics/copy/": { "post": { "operationId": "predefined-metrics-copy-create", "description": "Copy one or more predefined metrics (e.g. Voice Tone + Clarity, Latency, CSAT) into a project so they evaluate its calls. Pass `project_id` and either `predefined_metric_ids` or `metric_codes` from the predefined metrics list. Use this to add these built-in metrics — they cannot be created through the metrics create endpoint.", "summary": "Attach predefined metrics to a project", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedMetricCopyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PredefinedMetricCopyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PredefinedMetricCopyRequest" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetricList" } } } }, "description": "" } }, "x-mcp-expose": true, "x-mcp-destructive": true, "x-mint": { "mcp": { "enabled": true, "name": "predefined-metrics-copy-create", "description": "Copy one or more predefined metrics (e.g. Voice Tone + Clarity, Latency, CSAT) into a project so they evaluate its calls. Pass `project_id` and either `predefined_metric_ids` or `metric_codes` from the predefined metrics list. Use this to add these built-in metrics — they cannot be created through the metrics create endpoint." } } } }, "/test_framework/v1/results/": { "get": { "operationId": "results-v1-list", "description": "List test results.\n\nTo filter by status, use `results_retrieve(id=result_id)` and inspect `status` directly ('running', 'completed', 'failed') — there is no list-level status filter.\n\n**Result status:** a result marked `failed` indicates infrastructure failures (e.g. connection errors, websocket handshake failures), not metric evaluation failures. `success_runs_count` counts runs that reached terminal state regardless of connection errors. See `results_retrieve().failed_reasons` for the breakdown.\n\n**Scenarios filter note:** filtering by `scenarios` may return duplicate result rows when a result contains multiple runs of the same scenario — deduplicate by `result.id` if needed.\n\nAfter triggering a run, poll `results_retrieve(id=result_id)` until `status` is 'completed' or 'failed'. For outbound runs, each run's `outbound_dial_window_closes_at` shows the deadline by which your agent must dial in.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "Filter by agent ID" }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "Filter by project ID" }, { "in": "query", "name": "search", "schema": { "type": "string" }, "description": "Filter by Result name" }, { "in": "query", "name": "scenarios", "schema": { "type": "string" }, "description": "Filter by scenario IDs — comma-separated string (e.g. '24270,24271'), not a JSON array." } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResultList" } } }, "description": "" } }, "deprecated": true }, "post": { "operationId": "results-v1-create", "description": "Create a new test result", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Result" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Result" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results-external/": { "get": { "operationId": "results-v1-external-list", "description": "List test results.\n\nTo filter by status, use `results_retrieve(id=result_id)` and inspect `status` directly ('running', 'completed', 'failed') — there is no list-level status filter.\n\n**Result status:** a result marked `failed` indicates infrastructure failures (e.g. connection errors, websocket handshake failures), not metric evaluation failures. `success_runs_count` counts runs that reached terminal state regardless of connection errors. See `results_retrieve().failed_reasons` for the breakdown.\n\n**Scenarios filter note:** filtering by `scenarios` may return duplicate result rows when a result contains multiple runs of the same scenario — deduplicate by `result.id` if needed.\n\nAfter triggering a run, poll `results_retrieve(id=result_id)` until `status` is 'completed' or 'failed'. For outbound runs, each run's `outbound_dial_window_closes_at` shows the deadline by which your agent must dial in.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "Filter by agent ID" }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "Filter by project ID" }, { "in": "query", "name": "search", "schema": { "type": "string" }, "description": "Filter by Result name" }, { "in": "query", "name": "scenarios", "schema": { "type": "string" }, "description": "Filter by scenario IDs — comma-separated string (e.g. '24270,24271'), not a JSON array." } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResultList" } } }, "description": "" } }, "deprecated": true }, "post": { "operationId": "results-v1-external-create", "description": "Create a new test result", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Result" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Result" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results-external/{id}/": { "get": { "operationId": "results-v1-external-retrieve", "description": "`success` indicates whether the run passed its quality evaluation. A run with `success=false` either failed to connect (check `error_message`) or failed an evaluation check (check `evaluation`). `success_rate` is the percentage of runs with `success=true`.\n\nThe `runs` field is a dict keyed by run ID string (e.g. `{\"86368\": {...}, \"86367\": {...}}`), not an array — unlike the list endpoint. Each run also has a `call_id` STRING field (the provider's call identifier) — that is a data field, NOT an endpoint ID; do not pass it where `run_id` is expected.", "summary": "Retrieve a test result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultDetailV2" }, "examples": { "Success": { "value": { "id": "integer", "name": "string", "agent": "integer", "status": "string", "met_expected_outcome_count": "integer", "total_expected_outcome_count": "integer", "success_rate": "float", "run_as_text": "boolean", "is_cronjob": "boolean", "runs": { "run_id": { "id": "integer", "scenario": "integer", "outbound_number": "string", "expected_outcome": { "score": 100, "explanation": [ "✅ Positive outcome explanation with checkmark emoji", "❌ Negative outcome explanation with X emoji" ], "outcome_alignments": [ { "outcome": "string", "prompt_part": "string", "aligned": "boolean" } ] }, "success": "boolean", "evaluation": { "metrics": [ { "id": "integer", "name": "string", "type": "binary | continuous_qualitative | numeric | enum", "score": "number", "explanation": "string | array", "function_name": "string (optional)", "extra": { "categories": [ { "category": "string", "deviation": "string (optional)", "priority": "string (optional)" } ], "percentiles": { "p50": "number" } }, "enum": "string (for enum type metrics only)" } ] }, "timestamp": "datetime", "executed_at": "datetime", "error_message": "string", "status": "string", "duration": "string (MM:SS format)", "scenario_name": "string", "personality_name": "string", "metadata": "object", "inbound_number": "string" } }, "overall_evaluation": { "success_rate": "number", "metric_summary": { "metric_id": { "id": "integer", "name": "string", "type": "string", "score": "number", "explanation": "string (optional)", "function_name": "string", "vocera_defined_metric_code": "string (optional)", "p50": "number (for numeric metrics)" } }, "worst_performing_metrics": { "binary_adherence": [ "array of metric_ids" ] }, "numeric_metrics": [ { "name": "string", "type": "numeric", "value": "number", "percentiles": { "p50": "number" } } ], "enum_metrics": [ "array of metric_ids" ], "extra_metrics": [ { "name": "string (e.g., 'Expected Outcome', 'Average Ringing Duration')", "type": "string", "value": "number", "percentiles": { "p50": "number (optional)" } } ] }, "total_duration": "string (MM:SS format)", "total_runs_count": "integer", "completed_runs_count": "integer", "success_runs_count": "integer", "failed_runs_count": "integer", "scenarios": [ { "id": "integer", "name": "string" } ], "critical_categories": "array", "metrics": "array", "domain": "string (nullable)", "domain_logo": "string (nullable)", "runs_by_tags": "object", "latency_data": "object", "failed_reasons": "array", "run_settings": { "override_value": 10, "frequency": 2, "concurrency_limit": 5, "personality_ids": [ 3, 7 ], "test_profile_ids": [ 20 ], "mode": "same_number", "livekit_data": { "agent_name": "kit", "config": {}, "url": "wss://example" } }, "created_at": "datetime", "updated_at": "datetime" } } } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } }, "deprecated": true }, "put": { "operationId": "results-v1-external-update", "description": "Update a test result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ResultDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ResultDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultDetailV2" } } }, "description": "" } } }, "patch": { "operationId": "results-v1-external-partial-update", "description": "Update a test result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedResultDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedResultDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedResultDetailV2" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultDetailV2" } } }, "description": "" } } }, "delete": { "operationId": "results-v1-external-destroy", "description": "Delete a test result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/results-external/{id}/ask_about_failures/": { "post": { "operationId": "results-v1-external-ask-about-failures-create", "description": "Query failed runs chatbot", "summary": "Query failed runs chatbot", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "Results" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskAboutFailuresRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AskAboutFailuresRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AskAboutFailuresRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Streaming AI-generated analysis of test failures" }, "400": { "description": "Invalid request (missing or invalid question)" }, "404": { "description": "Result not found" }, "429": { "description": "Rate limit exceeded" } } } }, "/test_framework/v1/results-external/{id}/create_shareable_link_token/": { "post": { "operationId": "create-shareable-link-token", "description": "Generate shareable link for result", "summary": "Generate shareable link for result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "Results" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateShareableLinkToken" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateShareableLinkToken" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateShareableLinkToken" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaCreateShareableLinkTokenResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/results-external/{id}/delete_runs/": { "post": { "operationId": "delete-runs", "description": "⚠ Irreversible. Removes the specified runs from a result, then triggers re-evaluation so aggregate metrics recompute without them. Maximum 100 run IDs per request.", "summary": "Delete runs from result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "Results" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostDeleteRuns" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostDeleteRuns" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostDeleteRuns" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/test_framework/v1/results-external/{id}/end_calls/": { "post": { "operationId": "end-calls", "description": "End all calls in result", "summary": "End all calls in result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "Results" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "No response body" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/test_framework/v1/results-external/{id}/evaluate_metrics/": { "post": { "operationId": "results-v1-external-evaluate-metrics-create", "description": "Results v1 evaluate metrics", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostReRunResultDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostReRunResultDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostReRunResultDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results-external/{id}/regenerate_ai_summary/": { "post": { "operationId": "results-v1-external-regenerate-ai-summary-create", "description": "Queue a background job that regenerates the structured AI summary (what_happened / why_it_happened / how_to_fix), recommended next steps, and the workflow coverage for this result, based on its current runs. The new values appear on the next `results_retrieve` call once the job finishes.", "summary": "Regenerate the AI summary for a result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "Results" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "202": { "description": "Regeneration queued; poll results_retrieve to see the new ai_summary / next_steps." }, "404": { "description": "Result not found" } } } }, "/test_framework/v1/results-external/{id}/rerun/": { "post": { "operationId": "results-v1-external-rerun-create", "description": "Re-execute every scenario from a completed result against the same agent, creating a new result with a fresh set of runs. The connection mode (voice or text) and provider are inherited from the original runs. Consumes simulation credits (one run per scenario) and launches live calls, so the new result populates asynchronously.", "summary": "Re-run the scenarios from a completed test result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results-external/bulk_delete/": { "post": { "operationId": "bulk-delete-results", "description": "⚠ Irreversible. Soft-deletes each result (and its non-deleted runs) with the same side-effects as deleting a single result: outbound phone numbers are released when no queued runs remain, capacity-manager slots are freed, and active_sessions / pending_demand counters are decremented in aggregate. Maximum 100 result IDs per request. Results that are already deleted or that the caller cannot access are silently skipped — the response is 204 even when no results are deleted.", "summary": "Soft-delete multiple results", "tags": [ "Results" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostBulkDeleteResults" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostBulkDeleteResults" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostBulkDeleteResults" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/results-external/bulk_evaluate_metrics/": { "post": { "operationId": "bulk-evaluate-result-metrics", "description": "Schedules re-evaluation of the given metrics against every completed/failed, non-deleted run of every selected result. Metrics are validated against each agent's metric scope; balance is checked for the full batch up front before any work is dispatched. Each affected result's status is flipped to RUNNING. Maximum 100 result IDs per request.", "summary": "Re-evaluate metrics across multiple results", "tags": [ "Results" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostBulkEvaluateResultMetrics" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostBulkEvaluateResultMetrics" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostBulkEvaluateResultMetrics" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "No response body" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/results-external/bulk_export_progress/": { "get": { "operationId": "results-v1-external-bulk-export-progress-retrieve", "description": "Results v1 bulk export progress", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results-external/bulk_export_result_runs/": { "get": { "operationId": "results-v1-external-bulk-export-result-runs-retrieve", "description": "Bulk export results with progress tracking and file URL response.\nAccepts export_type in query params and applies the same filters as the queryset.", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results-external/export_result_runs/": { "get": { "operationId": "results-v1-external-export-result-runs-retrieve", "description": "Results v1 export result runs", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results-external/reports/": { "get": { "operationId": "results-v1-external-reports-retrieve", "description": "Results v1 reports", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results-external/reports/ask-about-failures/": { "post": { "operationId": "results-v1-external-reports-ask-about-failures-create", "description": "Query failed runs chatbot for combined reports", "summary": "Query failed runs chatbot for combined reports", "tags": [ "Results" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskAboutFailuresReportsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AskAboutFailuresReportsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AskAboutFailuresReportsRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Streaming AI-generated analysis of test failures across combined results" }, "400": { "description": "Invalid request (missing result_ids or question)" }, "404": { "description": "No results found" }, "429": { "description": "Rate limit exceeded" } } } }, "/test_framework/v1/results-external/reports/share/": { "post": { "operationId": "results-v1-external-reports-share-create", "description": "Results v1 reports share", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Result" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Result" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results-external/result_ids/": { "get": { "operationId": "results-v1-external-result-ids-retrieve", "description": "Results v1 result ids", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results/{id}/": { "get": { "operationId": "results-v1-retrieve", "description": "`success` indicates whether the run passed its quality evaluation. A run with `success=false` either failed to connect (check `error_message`) or failed an evaluation check (check `evaluation`). `success_rate` is the percentage of runs with `success=true`.\n\nThe `runs` field is a dict keyed by run ID string (e.g. `{\"86368\": {...}, \"86367\": {...}}`), not an array — unlike the list endpoint. Each run also has a `call_id` STRING field (the provider's call identifier) — that is a data field, NOT an endpoint ID; do not pass it where `run_id` is expected.", "summary": "Retrieve a test result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultDetailV2" }, "examples": { "Success": { "value": { "id": "integer", "name": "string", "agent": "integer", "status": "string", "met_expected_outcome_count": "integer", "total_expected_outcome_count": "integer", "success_rate": "float", "run_as_text": "boolean", "is_cronjob": "boolean", "runs": { "run_id": { "id": "integer", "scenario": "integer", "outbound_number": "string", "expected_outcome": { "score": 100, "explanation": [ "✅ Positive outcome explanation with checkmark emoji", "❌ Negative outcome explanation with X emoji" ], "outcome_alignments": [ { "outcome": "string", "prompt_part": "string", "aligned": "boolean" } ] }, "success": "boolean", "evaluation": { "metrics": [ { "id": "integer", "name": "string", "type": "binary | continuous_qualitative | numeric | enum", "score": "number", "explanation": "string | array", "function_name": "string (optional)", "extra": { "categories": [ { "category": "string", "deviation": "string (optional)", "priority": "string (optional)" } ], "percentiles": { "p50": "number" } }, "enum": "string (for enum type metrics only)" } ] }, "timestamp": "datetime", "executed_at": "datetime", "error_message": "string", "status": "string", "duration": "string (MM:SS format)", "scenario_name": "string", "personality_name": "string", "metadata": "object", "inbound_number": "string" } }, "overall_evaluation": { "success_rate": "number", "metric_summary": { "metric_id": { "id": "integer", "name": "string", "type": "string", "score": "number", "explanation": "string (optional)", "function_name": "string", "vocera_defined_metric_code": "string (optional)", "p50": "number (for numeric metrics)" } }, "worst_performing_metrics": { "binary_adherence": [ "array of metric_ids" ] }, "numeric_metrics": [ { "name": "string", "type": "numeric", "value": "number", "percentiles": { "p50": "number" } } ], "enum_metrics": [ "array of metric_ids" ], "extra_metrics": [ { "name": "string (e.g., 'Expected Outcome', 'Average Ringing Duration')", "type": "string", "value": "number", "percentiles": { "p50": "number (optional)" } } ] }, "total_duration": "string (MM:SS format)", "total_runs_count": "integer", "completed_runs_count": "integer", "success_runs_count": "integer", "failed_runs_count": "integer", "scenarios": [ { "id": "integer", "name": "string" } ], "critical_categories": "array", "metrics": "array", "domain": "string (nullable)", "domain_logo": "string (nullable)", "runs_by_tags": "object", "latency_data": "object", "failed_reasons": "array", "run_settings": { "override_value": 10, "frequency": 2, "concurrency_limit": 5, "personality_ids": [ 3, 7 ], "test_profile_ids": [ 20 ], "mode": "same_number", "livekit_data": { "agent_name": "kit", "config": {}, "url": "wss://example" } }, "created_at": "datetime", "updated_at": "datetime" } } } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } }, "deprecated": true }, "put": { "operationId": "results-v1-update", "description": "Update a test result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ResultDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ResultDetailV2" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultDetailV2" } } }, "description": "" } } }, "patch": { "operationId": "results-v1-partial-update", "description": "Update a test result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedResultDetailV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedResultDetailV2" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedResultDetailV2" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultDetailV2" } } }, "description": "" } } }, "delete": { "operationId": "results-v1-destroy", "description": "Delete a test result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/results/{id}/ask_about_failures/": { "post": { "operationId": "results-v1-ask-about-failures-create", "description": "Query failed runs chatbot", "summary": "Query failed runs chatbot", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "Results" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskAboutFailuresRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AskAboutFailuresRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AskAboutFailuresRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Streaming AI-generated analysis of test failures" }, "400": { "description": "Invalid request (missing or invalid question)" }, "404": { "description": "Result not found" }, "429": { "description": "Rate limit exceeded" } } } }, "/test_framework/v1/results/{id}/create_shareable_link_token/": { "post": { "operationId": "create-shareable-link-token_2", "description": "Generate shareable link for result", "summary": "Generate shareable link for result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "Results" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateShareableLinkToken" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateShareableLinkToken" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostCreateShareableLinkToken" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaCreateShareableLinkTokenResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/results/{id}/delete_runs/": { "post": { "operationId": "delete-runs_2", "description": "⚠ Irreversible. Removes the specified runs from a result, then triggers re-evaluation so aggregate metrics recompute without them. Maximum 100 run IDs per request.", "summary": "Delete runs from result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "Results" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostDeleteRuns" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostDeleteRuns" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostDeleteRuns" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/test_framework/v1/results/{id}/end_calls/": { "post": { "operationId": "end-calls_2", "description": "End all calls in result", "summary": "End all calls in result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "Results" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "No response body" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/test_framework/v1/results/{id}/evaluate_metrics/": { "post": { "operationId": "results-v1-evaluate-metrics-create", "description": "Results v1 evaluate metrics", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostReRunResultDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostReRunResultDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostReRunResultDetail" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results/{id}/regenerate_ai_summary/": { "post": { "operationId": "results-v1-regenerate-ai-summary-create", "description": "Queue a background job that regenerates the structured AI summary (what_happened / why_it_happened / how_to_fix), recommended next steps, and the workflow coverage for this result, based on its current runs. The new values appear on the next `results_retrieve` call once the job finishes.", "summary": "Regenerate the AI summary for a result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "Results" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "202": { "description": "Regeneration queued; poll results_retrieve to see the new ai_summary / next_steps." }, "404": { "description": "Result not found" } } } }, "/test_framework/v1/results/{id}/rerun/": { "post": { "operationId": "results-v1-rerun-create", "description": "Re-execute every scenario from a completed result against the same agent, creating a new result with a fresh set of runs. The connection mode (voice or text) and provider are inherited from the original runs. Consumes simulation credits (one run per scenario) and launches live calls, so the new result populates asynchronously.", "summary": "Re-run the scenarios from a completed test result", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this result.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results/bulk_delete/": { "post": { "operationId": "bulk-delete-results_2", "description": "⚠ Irreversible. Soft-deletes each result (and its non-deleted runs) with the same side-effects as deleting a single result: outbound phone numbers are released when no queued runs remain, capacity-manager slots are freed, and active_sessions / pending_demand counters are decremented in aggregate. Maximum 100 result IDs per request. Results that are already deleted or that the caller cannot access are silently skipped — the response is 204 even when no results are deleted.", "summary": "Soft-delete multiple results", "tags": [ "Results" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostBulkDeleteResults" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostBulkDeleteResults" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostBulkDeleteResults" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/results/bulk_evaluate_metrics/": { "post": { "operationId": "bulk-evaluate-result-metrics_2", "description": "Schedules re-evaluation of the given metrics against every completed/failed, non-deleted run of every selected result. Metrics are validated against each agent's metric scope; balance is checked for the full batch up front before any work is dispatched. Each affected result's status is flipped to RUNNING. Maximum 100 result IDs per request.", "summary": "Re-evaluate metrics across multiple results", "tags": [ "Results" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostBulkEvaluateResultMetrics" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostBulkEvaluateResultMetrics" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostBulkEvaluateResultMetrics" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "No response body" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/results/bulk_export_progress/": { "get": { "operationId": "results-v1-bulk-export-progress-retrieve", "description": "Results v1 bulk export progress", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results/bulk_export_result_runs/": { "get": { "operationId": "results-v1-bulk-export-result-runs-retrieve", "description": "Bulk export results with progress tracking and file URL response.\nAccepts export_type in query params and applies the same filters as the queryset.", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results/export_result_runs/": { "get": { "operationId": "results-v1-export-result-runs-retrieve", "description": "Results v1 export result runs", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results/reports/": { "get": { "operationId": "results-v1-reports-retrieve", "description": "Results v1 reports", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results/reports/ask-about-failures/": { "post": { "operationId": "results-v1-reports-ask-about-failures-create", "description": "Query failed runs chatbot for combined reports", "summary": "Query failed runs chatbot for combined reports", "tags": [ "Results" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskAboutFailuresReportsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AskAboutFailuresReportsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AskAboutFailuresReportsRequest" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Streaming AI-generated analysis of test failures across combined results" }, "400": { "description": "Invalid request (missing result_ids or question)" }, "404": { "description": "No results found" }, "429": { "description": "Rate limit exceeded" } } } }, "/test_framework/v1/results/reports/share/": { "post": { "operationId": "results-v1-reports-share-create", "description": "Results v1 reports share", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Result" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Result" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/results/result_ids/": { "get": { "operationId": "results-v1-result-ids-retrieve", "description": "Results v1 result ids", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } }, "description": "" } } } }, "/test_framework/v1/runs/": { "get": { "operationId": "runs-v1-list", "description": "List test runs", "parameters": [ { "in": "query", "name": "id__in", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "id", "schema": { "type": "string" } }, { "in": "query", "name": "id__contains", "schema": { "type": "integer" } }, { "in": "query", "name": "timestamp__gte", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "timestamp__lte", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "result__agent_id", "schema": { "type": "integer" } }, { "in": "query", "name": "result__agent_id__in", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "status__in", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "status", "schema": { "type": "string", "x-spec-enum-id": "623e22fc1eb17833", "enum": [ "cancelled", "completed", "evaluating", "failed", "in_progress", "in_queue", "pending", "running", "scaling_up", "timeout" ] }, "description": "* `running` - Running\n* `completed` - Completed\n* `failed` - Failed\n* `pending` - Pending\n* `in_progress` - In Progress\n* `evaluating` - Evaluating\n* `in_queue` - In Queue\n* `timeout` - Timeout\n* `cancelled` - Cancelled\n* `scaling_up` - Scaling Up" }, { "in": "query", "name": "success", "schema": { "type": "boolean" } }, { "in": "query", "name": "duration__gte", "schema": { "type": "number", "format": "float" } }, { "in": "query", "name": "duration__lte", "schema": { "type": "number", "format": "float" } }, { "in": "query", "name": "call_id__icontains", "schema": { "type": "string" } }, { "in": "query", "name": "call_id", "schema": { "type": "string" } }, { "in": "query", "name": "provider_call_id__icontains", "schema": { "type": "string" } }, { "in": "query", "name": "provider_call_id", "schema": { "type": "string" } }, { "in": "query", "name": "scenario__id__in", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "scenario__id", "schema": { "type": "integer" } }, { "in": "query", "name": "personality__id__in", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "personality__id", "schema": { "type": "integer" } }, { "in": "query", "name": "result__id", "schema": { "type": "integer" } }, { "in": "query", "name": "result__run_as_text", "schema": { "type": "boolean" } }, { "in": "query", "name": "created_at_from", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "created_at_to", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "Filter runs by agent ID" }, { "in": "query", "name": "assistant_id", "schema": { "type": "string" } }, { "in": "query", "name": "scenarios", "schema": { "type": "string" } }, { "in": "query", "name": "tags", "schema": { "type": "string" } }, { "in": "query", "name": "personalities", "schema": { "type": "string" } }, { "in": "query", "name": "success_rate", "schema": { "type": "number" } }, { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "call_ended_reason", "schema": { "type": "string" } }, { "in": "query", "name": "call_ended_reason__icontains", "schema": { "type": "string" } }, { "in": "query", "name": "call_ended_reason__in", "schema": { "type": "string" } }, { "in": "query", "name": "created_at_range", "schema": { "type": "string" } }, { "in": "query", "name": "duration_range", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "Filter runs by project ID" }, { "in": "query", "name": "result_id", "schema": { "type": "integer" }, "description": "Filter runs by result ID" } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRunListList" } } }, "description": "" } }, "deprecated": true } }, "/test_framework/v1/runs-external/": { "get": { "operationId": "runs-v1-external-list", "description": "List test runs", "parameters": [ { "in": "query", "name": "id__in", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "id", "schema": { "type": "string" } }, { "in": "query", "name": "id__contains", "schema": { "type": "integer" } }, { "in": "query", "name": "timestamp__gte", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "timestamp__lte", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "result__agent_id", "schema": { "type": "integer" } }, { "in": "query", "name": "result__agent_id__in", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "status__in", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "status", "schema": { "type": "string", "x-spec-enum-id": "623e22fc1eb17833", "enum": [ "cancelled", "completed", "evaluating", "failed", "in_progress", "in_queue", "pending", "running", "scaling_up", "timeout" ] }, "description": "* `running` - Running\n* `completed` - Completed\n* `failed` - Failed\n* `pending` - Pending\n* `in_progress` - In Progress\n* `evaluating` - Evaluating\n* `in_queue` - In Queue\n* `timeout` - Timeout\n* `cancelled` - Cancelled\n* `scaling_up` - Scaling Up" }, { "in": "query", "name": "success", "schema": { "type": "boolean" } }, { "in": "query", "name": "duration__gte", "schema": { "type": "number", "format": "float" } }, { "in": "query", "name": "duration__lte", "schema": { "type": "number", "format": "float" } }, { "in": "query", "name": "call_id__icontains", "schema": { "type": "string" } }, { "in": "query", "name": "call_id", "schema": { "type": "string" } }, { "in": "query", "name": "provider_call_id__icontains", "schema": { "type": "string" } }, { "in": "query", "name": "provider_call_id", "schema": { "type": "string" } }, { "in": "query", "name": "scenario__id__in", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "scenario__id", "schema": { "type": "integer" } }, { "in": "query", "name": "personality__id__in", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "personality__id", "schema": { "type": "integer" } }, { "in": "query", "name": "result__id", "schema": { "type": "integer" } }, { "in": "query", "name": "result__run_as_text", "schema": { "type": "boolean" } }, { "in": "query", "name": "created_at_from", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "created_at_to", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "Filter runs by agent ID" }, { "in": "query", "name": "assistant_id", "schema": { "type": "string" } }, { "in": "query", "name": "scenarios", "schema": { "type": "string" } }, { "in": "query", "name": "tags", "schema": { "type": "string" } }, { "in": "query", "name": "personalities", "schema": { "type": "string" } }, { "in": "query", "name": "success_rate", "schema": { "type": "number" } }, { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "call_ended_reason", "schema": { "type": "string" } }, { "in": "query", "name": "call_ended_reason__icontains", "schema": { "type": "string" } }, { "in": "query", "name": "call_ended_reason__in", "schema": { "type": "string" } }, { "in": "query", "name": "created_at_range", "schema": { "type": "string" } }, { "in": "query", "name": "duration_range", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "Filter runs by project ID" }, { "in": "query", "name": "result_id", "schema": { "type": "integer" }, "description": "Filter runs by result ID" } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRunListList" } } }, "description": "" } }, "deprecated": true } }, "/test_framework/v1/runs-external/{id}/": { "get": { "operationId": "runs-v1-external-retrieve", "description": "Retrieve a test run by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } }, "deprecated": true }, "put": { "operationId": "runs-v1-external-update", "description": "Update a test run", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Run" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } }, "patch": { "operationId": "runs-v1-external-partial-update", "description": "Update a test run", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedRun" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedRun" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedRun" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } }, "delete": { "operationId": "runs-v1-external-destroy", "description": "Delete a test run", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/runs-external/{id}/chat/": { "post": { "operationId": "runs-api-chat", "description": "Submit your agent-under-test's latest message on a customer-driven (API chat) run. The simulated user's reply is generated in the background — the response returns a `turn_id` immediately; poll GET /runs/{run_id}/chat/{turn_id}/ until its `status` is `ready` to read the reply, then submit the next turn. Submitting a new turn while one is still generating interrupts it: the older turn is marked `dropped` but its message is kept, and the newest turn's reply answers all messages received since the last reply. Repeat until `ended` is true (or call end-chat).", "summary": "Submit a turn to an API-chat run", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "Runs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiChatTurn" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ApiChatTurn" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ApiChatTurn" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiChatTurnSubmitResponse" } } }, "description": "" }, "409": { "description": "Run is still starting, or has already ended." } } } }, "/test_framework/v1/runs-external/{id}/chat/{turn_id}/": { "get": { "operationId": "runs-api-chat-turn", "description": "Poll for the simulated user's reply to a turn submitted via POST /runs/{run_id}/chat/. `status` is `generating` until the reply is ready, then `ready` (with `message` and `ended`). `dropped` means the turn was superseded by a newer submission — its message is kept and the newer turn's reply answers both; `error` means generation failed. Turn 0 is the run's opening: `message` is the evaluator's first message, or null when your agent speaks first. Any turn stays pollable until the run's turn history expires, so the last reply is still retrievable after the run finishes.", "summary": "Poll a submitted API-chat turn", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true }, { "in": "path", "name": "turn_id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "Runs" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiChatTurnPollResponse" } } }, "description": "" }, "404": { "description": "Unknown turn." } } } }, "/test_framework/v1/runs-external/{id}/end-chat/": { "post": { "operationId": "runs-api-chat-end", "description": "Finish an API-chat run", "summary": "Finish an API-chat run", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "Runs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiChatFinish" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ApiChatFinish" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ApiChatFinish" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiChatFinishResponse" } } }, "description": "" } } } }, "/test_framework/v1/runs-external/{id}/end_call/": { "post": { "operationId": "end-call", "description": "End a single call", "summary": "End a single call", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "Runs" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "No response body" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/test_framework/v1/runs-external/{id}/get_listen_url/": { "get": { "operationId": "runs-v1-external-get-listen-url-retrieve", "description": "Runs v1 get listen url", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } } }, "/test_framework/v1/runs-external/{id}/mark_critical_scenario_wrong/": { "post": { "operationId": "runs-v1-external-mark-critical-scenario-wrong-create", "description": "Runs v1 mark critical scenario wrong", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Run" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } } }, "/test_framework/v1/runs-external/{id}/mark_expected_outcome_vote/": { "post": { "operationId": "runs-v1-external-mark-expected-outcome-vote-create", "description": "Runs v1 mark expected outcome vote", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Run" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } } }, "/test_framework/v1/runs-external/{id}/mark_metric_vote/": { "post": { "operationId": "runs-v1-external-mark-metric-vote-create", "description": "Record a thumbs-up or thumbs-down vote on a specific metric evaluation for this run and optionally provide an expected value and free-text feedback. Updates the metric evaluation and marks the run as reviewed.", "summary": "Submit a metric vote for a run", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "Runs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkMetricVoteRunResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/test_framework/v1/runs-external/{id}/run_expected_outcome_bg/": { "post": { "operationId": "runs-v1-external-run-expected-outcome-bg-create", "description": "Runs v1 run expected outcome bg", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Run" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } } }, "/test_framework/v1/runs-external/{id}/unmark_critical_scenario_wrong/": { "post": { "operationId": "runs-v1-external-unmark-critical-scenario-wrong-create", "description": "Runs v1 unmark critical scenario wrong", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Run" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } } }, "/test_framework/v1/runs-external/bulk/": { "get": { "operationId": "runs-v1-external-bulk-retrieve", "description": "Retrieve multiple runs in a single request.\n\n`success: true` indicates the run passed its quality evaluation. A run with `success=false` either failed to connect (check `error_message`) or failed an evaluation check. For detailed outcomes check: `error_message`, `metadata.ended_reason`, and `evaluation.metrics[].result`.", "parameters": [ { "in": "query", "name": "run_ids", "schema": { "type": "string" }, "description": "\nComma-separated list of run IDs.\nExample: `1,2,3`\n\nMust be a plain comma-separated string, not a JSON array — passing a JSON array returns a 400 error.\n", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Run" } } } }, "description": "" } }, "deprecated": true } }, "/test_framework/v1/runs-external/run_expected_outcome_progress/": { "get": { "operationId": "runs-v1-external-run-expected-outcome-progress-retrieve", "description": "Runs v1 run expected outcome progress", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } } }, "/test_framework/v1/runs/{id}/": { "get": { "operationId": "runs-v1-retrieve", "description": "Retrieve a test run by ID", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } }, "deprecated": true }, "put": { "operationId": "runs-v1-update", "description": "Update a test run", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Run" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } }, "patch": { "operationId": "runs-v1-partial-update", "description": "Update a test run", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedRun" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedRun" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedRun" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } }, "delete": { "operationId": "runs-v1-destroy", "description": "Delete a test run", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/runs/{id}/chat/": { "post": { "operationId": "runs-api-chat_2", "description": "Submit your agent-under-test's latest message on a customer-driven (API chat) run. The simulated user's reply is generated in the background — the response returns a `turn_id` immediately; poll GET /runs/{run_id}/chat/{turn_id}/ until its `status` is `ready` to read the reply, then submit the next turn. Submitting a new turn while one is still generating interrupts it: the older turn is marked `dropped` but its message is kept, and the newest turn's reply answers all messages received since the last reply. Repeat until `ended` is true (or call end-chat).", "summary": "Submit a turn to an API-chat run", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "Runs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiChatTurn" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ApiChatTurn" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ApiChatTurn" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiChatTurnSubmitResponse" } } }, "description": "" }, "409": { "description": "Run is still starting, or has already ended." } } } }, "/test_framework/v1/runs/{id}/chat/{turn_id}/": { "get": { "operationId": "runs-api-chat-turn_2", "description": "Poll for the simulated user's reply to a turn submitted via POST /runs/{run_id}/chat/. `status` is `generating` until the reply is ready, then `ready` (with `message` and `ended`). `dropped` means the turn was superseded by a newer submission — its message is kept and the newer turn's reply answers both; `error` means generation failed. Turn 0 is the run's opening: `message` is the evaluator's first message, or null when your agent speaks first. Any turn stays pollable until the run's turn history expires, so the last reply is still retrievable after the run finishes.", "summary": "Poll a submitted API-chat turn", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true }, { "in": "path", "name": "turn_id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "Runs" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiChatTurnPollResponse" } } }, "description": "" }, "404": { "description": "Unknown turn." } } } }, "/test_framework/v1/runs/{id}/end-chat/": { "post": { "operationId": "runs-api-chat-end_2", "description": "Finish an API-chat run", "summary": "Finish an API-chat run", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "Runs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiChatFinish" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ApiChatFinish" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ApiChatFinish" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiChatFinishResponse" } } }, "description": "" } } } }, "/test_framework/v1/runs/{id}/end_call/": { "post": { "operationId": "end-call_2", "description": "End a single call", "summary": "End a single call", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "Runs" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "description": "No response body" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/test_framework/v1/runs/{id}/get_listen_url/": { "get": { "operationId": "runs-v1-get-listen-url-retrieve", "description": "Runs v1 get listen url", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } } }, "/test_framework/v1/runs/{id}/mark_critical_scenario_wrong/": { "post": { "operationId": "runs-v1-mark-critical-scenario-wrong-create", "description": "Runs v1 mark critical scenario wrong", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Run" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } } }, "/test_framework/v1/runs/{id}/mark_expected_outcome_vote/": { "post": { "operationId": "runs-v1-mark-expected-outcome-vote-create", "description": "Runs v1 mark expected outcome vote", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Run" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } } }, "/test_framework/v1/runs/{id}/mark_metric_vote/": { "post": { "operationId": "runs-v1-mark-metric-vote-create", "description": "Record a thumbs-up or thumbs-down vote on a specific metric evaluation for this run and optionally provide an expected value and free-text feedback. Updates the metric evaluation and marks the run as reviewed.", "summary": "Submit a metric vote for a run", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "Runs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MarkMetricVote" } } }, "required": true }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkMetricVoteRunResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/test_framework/v1/runs/{id}/run_expected_outcome_bg/": { "post": { "operationId": "runs-v1-run-expected-outcome-bg-create", "description": "Runs v1 run expected outcome bg", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Run" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } } }, "/test_framework/v1/runs/{id}/trace/": { "get": { "operationId": "runs-trace-retrieve", "description": "Retrieve the raw OpenTelemetry trace associated with a simulation run.\n\nBefore calling this tool, retrieve the run with `runs_bulk_retrieve` and confirm that its `trace_id` is non-empty; an empty `trace_id` means no trace is available. Pass the run's integer `id`, not its provider call identifier or its `trace_id`.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunTraceResponse" } } }, "description": "" }, "404": { "description": "The run does not exist, has no trace ID, or its trace was not found." } }, "x-mcp-expose": true, "summary": "Get a run's trace", "x-mint": { "mcp": { "enabled": true, "name": "runs-trace-retrieve", "description": "Retrieve the raw OpenTelemetry trace associated with a simulation run.\n\nBefore calling this tool, retrieve the run with `runs_bulk_retrieve` and confirm that its `trace_id` is non-empty; an empty `trace_id` means no trace is available. Pass the run's integer `id`, not its provider call identifier or its `trace_id`." } } } }, "/test_framework/v1/runs/{id}/unmark_critical_scenario_wrong/": { "post": { "operationId": "runs-v1-unmark-critical-scenario-wrong-create", "description": "Runs v1 unmark critical scenario wrong", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this run.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Run" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } } }, "/test_framework/v1/runs/bulk/": { "get": { "operationId": "runs-v1-bulk-retrieve", "description": "Retrieve multiple runs in a single request.\n\n`success: true` indicates the run passed its quality evaluation. A run with `success=false` either failed to connect (check `error_message`) or failed an evaluation check. For detailed outcomes check: `error_message`, `metadata.ended_reason`, and `evaluation.metrics[].result`.", "parameters": [ { "in": "query", "name": "run_ids", "schema": { "type": "string" }, "description": "\nComma-separated list of run IDs.\nExample: `1,2,3`\n\nMust be a plain comma-separated string, not a JSON array — passing a JSON array returns a 400 error.\n", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Run" } } } }, "description": "" } }, "deprecated": true } }, "/test_framework/v1/runs/run_expected_outcome_progress/": { "get": { "operationId": "runs-v1-run-expected-outcome-progress-retrieve", "description": "Runs v1 run expected outcome progress", "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "shareable_link": [] }, { "supabase_session": [] }, { "embedded_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } }, "description": "" } } } }, "/test_framework/v1/scenario-improvement-sessions/": { "get": { "operationId": "scenario-improvement-sessions-list", "description": "List scenario-improvement sessions for a project. Each session tracks an AI-assisted refinement run over the project's scenarios. Requires `project_id`.", "summary": "List scenario improvement sessions", "tags": [ "Scenarios" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScenarioImprovementSessionList" } } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "scenario-improvement-sessions-list", "description": "List scenario-improvement sessions for a project. Each session tracks an AI-assisted refinement run over the project's scenarios. Requires `project_id`." } }, "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Tenant scope. Supply one of `project_id` when authenticating with a user session or OAuth bearer token; omit when using an API key already scoped to the tenant." } ] }, "post": { "operationId": "scenario-improvement-sessions-create", "description": "Create a scenario improvement session", "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioImprovementSessionCreate" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ScenarioImprovementSessionCreate" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ScenarioImprovementSessionCreate" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioImprovementSessionCreate" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Create a scenario improvement session", "x-mint": { "mcp": { "enabled": true, "name": "scenario-improvement-sessions-create", "description": "Create a scenario improvement session" } } } }, "/test_framework/v1/scenario-improvement-sessions/{id}/": { "get": { "operationId": "scenario-improvement-sessions-retrieve", "description": "Get a scenario improvement session", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this scenario improvement session.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioImprovementSessionDetail" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Get a scenario improvement session", "x-mint": { "mcp": { "enabled": true, "name": "scenario-improvement-sessions-retrieve", "description": "Get a scenario improvement session" } } }, "put": { "operationId": "scenario-improvement-sessions-update", "description": "Update a ViewSet", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this scenario improvement session.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioImprovementSessionDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ScenarioImprovementSessionDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ScenarioImprovementSessionDetail" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioImprovementSessionDetail" } } }, "description": "" } } }, "patch": { "operationId": "scenario-improvement-sessions-partial-update", "description": "Update a scenario improvement session", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this scenario improvement session.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedScenarioImprovementSessionDetail" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedScenarioImprovementSessionDetail" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedScenarioImprovementSessionDetail" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioImprovementSessionDetail" } } }, "description": "" } }, "x-mcp-expose": true, "summary": "Update a scenario improvement session", "x-mint": { "mcp": { "enabled": true, "name": "scenario-improvement-sessions-partial-update", "description": "Update a scenario improvement session" } } }, "delete": { "operationId": "scenario-improvement-sessions-destroy", "description": "Delete a ViewSet", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this scenario improvement session.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" } } } }, "/test_framework/v1/scenarios/": { "get": { "operationId": "scenarios-list", "description": "scenarios_list: List evaluators (test scenarios) that simulate callers interacting with your agent. Filter by `agent_id`, `project_id`, `tags`, `folder_path`, or other params (see Schema). Returns paginated scenarios with their instructions, type, personalities, and metrics.\n\nPerformance tip: pass the most specific filter you have. `agent_id` if a specific agent is in context, `folder_path` if you're discussing a specific folder, or `project_id` for a workspace-level view. `page_size=20` is a reasonable starting size if you want to peek at recent ones first.", "summary": "List evaluators (scenarios)", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "\nFilter evaluators by agent ID\nExample: `2142`\n" }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "\nFilter evaluators by project ID\nExample: `1`\n" }, { "in": "query", "name": "assistant_id", "schema": { "type": "string", "minLength": 1 }, "description": "\nFilter evaluators by assistant ID\nExample: `asst_1234567890`\n" }, { "in": "query", "name": "tags", "schema": { "type": "string", "minLength": 1 }, "description": "\nComma-separated list of tags to filter evaluators by\nExample: `tag1,tag2,tag3`\n" }, { "in": "query", "name": "tag_filter_type", "schema": { "enum": [ "and", "or", "not" ], "type": "string", "x-spec-enum-id": "b8b9507605e7dc0e", "default": "or", "minLength": 1 }, "description": "\nFilter operation type for tags\n\n\n* `and` - and\n* `or` - or\n* `not` - not" }, { "in": "query", "name": "folder_path", "schema": { "type": "string" }, "description": "\nFilter evaluators by folder path. Use empty string to get evaluators without a folder.\nExample: `Sales.Inbound`\n" } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedScenarioListList" } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "scenarios-list", "description": "scenarios_list: List evaluators (test scenarios) that simulate callers interacting with your agent. Filter by `agent_id`, `project_id`, `tags`, `folder_path`, or other params (see Schema). Returns paginated scenarios with their instructions, type, personalities, and metrics.\n\nPerformance tip: pass the most specific filter you have. `agent_id` if a specific agent is in context, `folder_path` if you're discussing a specific folder, or `project_id` for a workspace-level view. `page_size=20` is a reasonable starting size if you want to peek at recent ones first." } } }, "post": { "operationId": "scenarios-create", "description": "scenarios_create: Create a test scenario (evaluator) that simulates a caller interacting with your agent. Required: `name`, `instructions` or program (see modes), and an `agent` or `project` to attach to.\n\n**Two modes — pick one via `scenario_type`:**\n\n- `instruction` (default, simplest) — put plain-text caller instructions in the `instructions` field. The simulated caller uses an LLM to paraphrase your instructions during the call.\n\n- `conditional_actions` — deterministic, rule-based caller. Provide the structured `conditional_actions` object. Use either `conditional_actions` or `instructions` — not both.\n\n**Common companion fields:**\n- `personality` (required) — caller voice/personality ID. Browse via `GET /personalities/`.\n- `metrics` — list of metric IDs to evaluate after each run.\n- `tags` — for grouping and later selection via `run_scenarios?tags=[...]`.\n- `folder_path` — e.g. `\"Sales.Inbound\"` for folder organization.\n- `test_profile` — a test profile ID providing caller metadata (order_id, user_email, etc.).\n\n**To run evaluators after creating:** call `run_scenarios` (voice), `run_scenarios_text`, `run_scenarios_with_websockets`, or `run_scenarios_pipecat` with the scenario ID(s) returned here.", "summary": "Create an evaluator (scenario)", "tags": [ "Scenarios" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostScenario" }, "examples": { "InstructionScenario(simplest—MostCommon)": { "value": { "agent": 12, "name": "Frustrated patient asking about billing", "scenario_type": "instruction", "instructions": "You are a patient who just got a surprise bill. Call the clinic, ask for the billing department, and refuse to pay until they explain each line item.", "personality": 3, "metrics": [ 5, 8 ], "tags": [ "billing", "angry-caller" ] }, "summary": "Instruction scenario (simplest — most common)" }, "ConditionalActions(structured,DeterministicFlow)": { "value": { "agent": 12, "name": "Happy path booking", "scenario_type": "conditional_actions", "conditional_actions": { "role": "You are a patient booking a dental appointment", "conditions": [ { "id": 0, "condition": "FIRST_MESSAGE", "action": "Hi, I'd like to book a dental cleaning.", "type": "standard", "fixed_message": true }, { "id": 1, "condition": "The agent asks when you'd like to come in", "action": "Next Tuesday afternoon works.", "type": "standard", "fixed_message": false }, { "id": 2, "condition": "The agent confirms the appointment is booked", "action": "Great, thanks! ", "type": "standard", "fixed_message": true } ] }, "personality": 3, "metrics": [ 5 ], "folder_path": "Booking.Happy path" }, "summary": "Conditional actions (structured, deterministic flow)" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostScenario" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostScenario" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaScenario" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } }, "x-mcp-expose": true, "x-mint": { "mcp": { "enabled": true, "name": "scenarios-create", "description": "scenarios_create: Create a test scenario (evaluator) that simulates a caller interacting with your agent. Required: `name`, `instructions` or program (see modes), and an `agent` or `project` to attach to.\n\n**Two modes — pick one via `scenario_type`:**\n\n- `instruction` (default, simplest) — put plain-text caller instructions in the `instructions` field. The simulated caller uses an LLM to paraphrase your instructions during the call.\n\n- `conditional_actions` — deterministic, rule-based caller. Provide the structured `conditional_actions` object. Use either `conditional_actions` or `instructions` — not both.\n\n**Common companion fields:**\n- `personality` (required) — caller voice/personality ID. Browse via `GET /personalities/`.\n- `metrics` — list of metric IDs to evaluate after each run.\n- `tags` — for grouping and later selection via `run_scenarios?tags=[...]`.\n- `folder_path` — e.g. `\"Sales.Inbound\"` for folder organization.\n- `test_profile` — a test profile ID providing caller metadata (order_id, user_email, etc.).\n\n**To run evaluators after creating:** call `run_scenarios` (voice), `run_scenarios_text`, `run_scenarios_with_websockets`, or `run_scenarios_pipecat` with the scenario ID(s) returned here." } } } }, "/test_framework/v1/scenarios-external/": { "get": { "operationId": "scenarios-external-list", "description": "scenarios_list: List evaluators (test scenarios) that simulate callers interacting with your agent. Filter by `agent_id`, `project_id`, `tags`, `folder_path`, or other params (see Schema). Returns paginated scenarios with their instructions, type, personalities, and metrics.\n\nPerformance tip: pass the most specific filter you have. `agent_id` if a specific agent is in context, `folder_path` if you're discussing a specific folder, or `project_id` for a workspace-level view. `page_size=20` is a reasonable starting size if you want to peek at recent ones first.", "summary": "List evaluators (scenarios)", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "agent_id", "schema": { "type": "integer" }, "description": "\nFilter evaluators by agent ID\nExample: `2142`\n" }, { "in": "query", "name": "project_id", "schema": { "type": "integer" }, "description": "\nFilter evaluators by project ID\nExample: `1`\n" }, { "in": "query", "name": "assistant_id", "schema": { "type": "string", "minLength": 1 }, "description": "\nFilter evaluators by assistant ID\nExample: `asst_1234567890`\n" }, { "in": "query", "name": "tags", "schema": { "type": "string", "minLength": 1 }, "description": "\nComma-separated list of tags to filter evaluators by\nExample: `tag1,tag2,tag3`\n" }, { "in": "query", "name": "tag_filter_type", "schema": { "enum": [ "and", "or", "not" ], "type": "string", "x-spec-enum-id": "b8b9507605e7dc0e", "default": "or", "minLength": 1 }, "description": "\nFilter operation type for tags\n\n\n* `and` - and\n* `or` - or\n* `not` - not" }, { "in": "query", "name": "folder_path", "schema": { "type": "string" }, "description": "\nFilter evaluators by folder path. Use empty string to get evaluators without a folder.\nExample: `Sales.Inbound`\n" } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedScenarioListList" } } }, "description": "" } } }, "post": { "operationId": "scenarios-external-create", "description": "scenarios_create: Create a test scenario (evaluator) that simulates a caller interacting with your agent. Required: `name`, `instructions` or program (see modes), and an `agent` or `project` to attach to.\n\n**Two modes — pick one via `scenario_type`:**\n\n- `instruction` (default, simplest) — put plain-text caller instructions in the `instructions` field. The simulated caller uses an LLM to paraphrase your instructions during the call.\n\n- `conditional_actions` — deterministic, rule-based caller. Provide the structured `conditional_actions` object. Use either `conditional_actions` or `instructions` — not both.\n\n**Common companion fields:**\n- `personality` (required) — caller voice/personality ID. Browse via `GET /personalities/`.\n- `metrics` — list of metric IDs to evaluate after each run.\n- `tags` — for grouping and later selection via `run_scenarios?tags=[...]`.\n- `folder_path` — e.g. `\"Sales.Inbound\"` for folder organization.\n- `test_profile` — a test profile ID providing caller metadata (order_id, user_email, etc.).\n\n**To run evaluators after creating:** call `run_scenarios` (voice), `run_scenarios_text`, `run_scenarios_with_websockets`, or `run_scenarios_pipecat` with the scenario ID(s) returned here.", "summary": "Create an evaluator (scenario)", "tags": [ "Scenarios" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaPostScenario" }, "examples": { "InstructionScenario(simplest—MostCommon)": { "value": { "agent": 12, "name": "Frustrated patient asking about billing", "scenario_type": "instruction", "instructions": "You are a patient who just got a surprise bill. Call the clinic, ask for the billing department, and refuse to pay until they explain each line item.", "personality": 3, "metrics": [ 5, 8 ], "tags": [ "billing", "angry-caller" ] }, "summary": "Instruction scenario (simplest — most common)" }, "ConditionalActions(structured,DeterministicFlow)": { "value": { "agent": 12, "name": "Happy path booking", "scenario_type": "conditional_actions", "conditional_actions": { "role": "You are a patient booking a dental appointment", "conditions": [ { "id": 0, "condition": "FIRST_MESSAGE", "action": "Hi, I'd like to book a dental cleaning.", "type": "standard", "fixed_message": true }, { "id": 1, "condition": "The agent asks when you'd like to come in", "action": "Next Tuesday afternoon works.", "type": "standard", "fixed_message": false }, { "id": 2, "condition": "The agent confirms the appointment is booked", "action": "Great, thanks! ", "type": "standard", "fixed_message": true } ] }, "personality": 3, "metrics": [ 5 ], "folder_path": "Booking.Happy path" }, "summary": "Conditional actions (structured, deterministic flow)" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SchemaPostScenario" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SchemaPostScenario" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaScenario" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } } }, "/test_framework/v1/scenarios-external/{id}/": { "get": { "operationId": "scenarios-external-retrieve", "description": "Fetch a single evaluator by id. Returns full configuration including instructions, expected outcome, metrics, test profile, and — when the agent has mock tools attached and the scenario was auto-generated — the expected mock tool calls (`generated_mock_tool_entries`) with their inputs and outputs.", "summary": "Retrieve an evaluator (scenario)", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this scenario.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaScenario" } } }, "description": "" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } }, "put": { "operationId": "scenarios-external-update", "description": "Update a test scenario", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this scenario.", "required": true } ], "tags": [ "test_framework" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Scenario" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Scenario" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Scenario" } } }, "required": true }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Scenario" } } }, "description": "" } } }, "patch": { "operationId": "scenarios-external-partial-update", "description": "Partially update an evaluator. Same field shape as create — see `scenarios_create` for details.\n\n**Tip:** to add or modify a single condition inside a `conditional_actions` scenario, fetch the scenario with GET, mutate its `conditional_actions` object, and PATCH the full object back. The server replaces all conditions atomically.", "summary": "Update an evaluator (scenario)", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this scenario.", "required": true } ], "tags": [ "Scenarios" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostScenario" }, "examples": { "Rename+TweakInstructions": { "value": { "name": "Refund flow v2", "instructions": "Ask for the order ID before refunding." }, "summary": "Rename + tweak instructions" } } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostScenario" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedSchemaPostScenario" } } } }, "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaScenario" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name": { "type": "array", "items": { "type": "string" } } } } } }, "description": "" } } }, "delete": { "operationId": "scenarios-external-destroy", "description": "⚠ Irreversible. Deletes the evaluator. Past runs remain in the result history but become orphaned in the UI.", "summary": "Delete an evaluator", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this scenario.", "required": true } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "204": { "description": "No response body" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detail": { "type": "string" } } } } }, "description": "" } } } }, "/test_framework/v1/scenarios-external/{id}/condition-audio/": { "get": { "operationId": "scenarios-external-condition-audio-list", "description": "Scenarios condition audio", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this scenario.", "required": true }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "test_framework" ], "security": [ { "oauth2": [] }, { "supabase_session": [] }, { "api_key": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConditionAudioEntryList" } } }, "description": "" } } }, "post": { "operationId": "scenarios-external-condition-audio-create", "description": "Attach an audio clip to a fixed-message conditional action. The clip is transcoded to 24kHz mono PCM WAV, stored in S3, and transcribed asynchronously. Pass action_template with one `