{ "info": { "_postman_id": "41f320c2-e2f3-47e2-937c-1e87d0a11184", "name": "Coval Agents Conversations API", "description": "\nManage configurations for simulations and evaluations.\n\n\nContact Support:\n Name: Coval API Support\n Email: support@coval.dev", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "lastUpdatedBy": "35240", "uid": "35240-41f320c2-e2f3-47e2-937c-1e87d0a11184" }, "item": [ { "name": "conversations:submit", "item": [ { "name": "Submit conversation for evaluation", "id": "2d9a43b0-e591-44a7-a7d3-7a0640827fd1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transcript\": [\n {\n \"role\": \"tool\",\n \"content\": \"\",\n \"message\": \"\",\n \"tool_calls\": [\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n }\n ],\n \"tool_call_id\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"timestamp\": \"\",\n \"firstWordStart\": \"\",\n \"lastWordEnd\": \"\"\n }\n ],\n \"audio_url\": \"\",\n \"upload_id\": \"upl_QR3Y031NYFCW72GG1HDR4RC21E\",\n \"metrics\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"est3f\": -34597920.42481649,\n \"Excepteur6\": \"culpa ut in sit\",\n \"dolorcc\": true,\n \"ut65\": \"la\"\n },\n \"tags\": [\n \"L[c4bqCXO 9!1Qq\",\n \"&a9%.&]{/\\\\qx\"\n ],\n \"external_conversation_id\": \"\",\n \"occurred_at\": \"\",\n \"agent_id\": \"t8vaDV3n7UP9x3aVUnVLgU\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations:submit", "host": [ "{{baseUrl}}" ], "path": [ "conversations:submit" ] }, "description": "Submit a conversation for monitoring evaluation.\n" }, "response": [ { "id": "73f064c3-bb0c-4477-a9f7-3626a7ff8176", "name": "Conversation submitted successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transcript\": [\n {\n \"role\": \"tool\",\n \"content\": \"\",\n \"message\": \"\",\n \"tool_calls\": [\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n }\n ],\n \"tool_call_id\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"timestamp\": \"\",\n \"firstWordStart\": \"\",\n \"lastWordEnd\": \"\"\n }\n ],\n \"audio_url\": \"\",\n \"upload_id\": \"upl_QR3Y031NYFCW72GG1HDR4RC21E\",\n \"metrics\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"est3f\": -34597920.42481649,\n \"Excepteur6\": \"culpa ut in sit\",\n \"dolorcc\": true,\n \"ut65\": \"la\"\n },\n \"tags\": [\n \"L[c4bqCXO 9!1Qq\",\n \"&a9%.&]{/\\\\qx\"\n ],\n \"external_conversation_id\": \"\",\n \"occurred_at\": \"\",\n \"agent_id\": \"t8vaDV3n7UP9x3aVUnVLgU\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations:submit", "host": [ "{{baseUrl}}" ], "path": [ "conversations:submit" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"conversation\": {\n \"name\": \"\",\n \"conversation_id\": \"\",\n \"status\": \"PENDING\",\n \"create_time\": \"\",\n \"external_conversation_id\": \"\",\n \"occurred_at\": \"\",\n \"has_audio\": \"\",\n \"agent_id\": \"rWGdUZQiiQxzKDu9aoUroz\",\n \"persona_id\": \"\",\n \"source\": {\n \"type\": \"phone\",\n \"value\": \"\"\n },\n \"destination\": {\n \"type\": \"phone\",\n \"value\": \"\"\n },\n \"progress\": {\n \"total_metrics\": \"\",\n \"completed_metrics\": \"\",\n \"failed_metrics\": \"\",\n \"in_progress_metrics\": \"\"\n },\n \"metadata\": {\n \"velit4\": 85154569,\n \"Excepteurb41\": true,\n \"eu_0\": \"magna fugiat occaecat\",\n \"et__\": 88311899\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"metric_ids\": [\n \"\",\n \"\"\n ],\n \"metric_outputs\": [\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"COMPLETED\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"eu_276\": 53899810\n }\n },\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"COMPLETED\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"labore_0\": -65549726,\n \"elit_5e\": 12179637\n }\n }\n ],\n \"error\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-73f064c3-bb0c-4477-a9f7-3626a7ff8176" }, { "id": "2e3c40a4-b636-4947-9b0e-5b1690ff55df", "name": "Invalid request arguments", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transcript\": [\n {\n \"role\": \"tool\",\n \"content\": \"\",\n \"message\": \"\",\n \"tool_calls\": [\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n }\n ],\n \"tool_call_id\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"timestamp\": \"\",\n \"firstWordStart\": \"\",\n \"lastWordEnd\": \"\"\n }\n ],\n \"audio_url\": \"\",\n \"upload_id\": \"upl_QR3Y031NYFCW72GG1HDR4RC21E\",\n \"metrics\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"est3f\": -34597920.42481649,\n \"Excepteur6\": \"culpa ut in sit\",\n \"dolorcc\": true,\n \"ut65\": \"la\"\n },\n \"tags\": [\n \"L[c4bqCXO 9!1Qq\",\n \"&a9%.&]{/\\\\qx\"\n ],\n \"external_conversation_id\": \"\",\n \"occurred_at\": \"\",\n \"agent_id\": \"t8vaDV3n7UP9x3aVUnVLgU\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations:submit", "host": [ "{{baseUrl}}" ], "path": [ "conversations:submit" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-2e3c40a4-b636-4947-9b0e-5b1690ff55df" }, { "id": "7df5e717-a46a-455d-8e54-36cd92a68940", "name": "Missing or invalid API key", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transcript\": [\n {\n \"role\": \"tool\",\n \"content\": \"\",\n \"message\": \"\",\n \"tool_calls\": [\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n }\n ],\n \"tool_call_id\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"timestamp\": \"\",\n \"firstWordStart\": \"\",\n \"lastWordEnd\": \"\"\n }\n ],\n \"audio_url\": \"\",\n \"upload_id\": \"upl_QR3Y031NYFCW72GG1HDR4RC21E\",\n \"metrics\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"est3f\": -34597920.42481649,\n \"Excepteur6\": \"culpa ut in sit\",\n \"dolorcc\": true,\n \"ut65\": \"la\"\n },\n \"tags\": [\n \"L[c4bqCXO 9!1Qq\",\n \"&a9%.&]{/\\\\qx\"\n ],\n \"external_conversation_id\": \"\",\n \"occurred_at\": \"\",\n \"agent_id\": \"t8vaDV3n7UP9x3aVUnVLgU\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations:submit", "host": [ "{{baseUrl}}" ], "path": [ "conversations:submit" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-7df5e717-a46a-455d-8e54-36cd92a68940" }, { "id": "39aaec24-db4e-4eb2-aeeb-5ce5647ad682", "name": "Referenced resource not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transcript\": [\n {\n \"role\": \"tool\",\n \"content\": \"\",\n \"message\": \"\",\n \"tool_calls\": [\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n }\n ],\n \"tool_call_id\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"timestamp\": \"\",\n \"firstWordStart\": \"\",\n \"lastWordEnd\": \"\"\n }\n ],\n \"audio_url\": \"\",\n \"upload_id\": \"upl_QR3Y031NYFCW72GG1HDR4RC21E\",\n \"metrics\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"est3f\": -34597920.42481649,\n \"Excepteur6\": \"culpa ut in sit\",\n \"dolorcc\": true,\n \"ut65\": \"la\"\n },\n \"tags\": [\n \"L[c4bqCXO 9!1Qq\",\n \"&a9%.&]{/\\\\qx\"\n ],\n \"external_conversation_id\": \"\",\n \"occurred_at\": \"\",\n \"agent_id\": \"t8vaDV3n7UP9x3aVUnVLgU\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations:submit", "host": [ "{{baseUrl}}" ], "path": [ "conversations:submit" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-39aaec24-db4e-4eb2-aeeb-5ce5647ad682" }, { "id": "afd11d41-6ff2-47ce-bc41-d5436c772b3f", "name": "Request payload exceeds size limit", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transcript\": [\n {\n \"role\": \"tool\",\n \"content\": \"\",\n \"message\": \"\",\n \"tool_calls\": [\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n }\n ],\n \"tool_call_id\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"timestamp\": \"\",\n \"firstWordStart\": \"\",\n \"lastWordEnd\": \"\"\n }\n ],\n \"audio_url\": \"\",\n \"upload_id\": \"upl_QR3Y031NYFCW72GG1HDR4RC21E\",\n \"metrics\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"est3f\": -34597920.42481649,\n \"Excepteur6\": \"culpa ut in sit\",\n \"dolorcc\": true,\n \"ut65\": \"la\"\n },\n \"tags\": [\n \"L[c4bqCXO 9!1Qq\",\n \"&a9%.&]{/\\\\qx\"\n ],\n \"external_conversation_id\": \"\",\n \"occurred_at\": \"\",\n \"agent_id\": \"t8vaDV3n7UP9x3aVUnVLgU\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations:submit", "host": [ "{{baseUrl}}" ], "path": [ "conversations:submit" ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-afd11d41-6ff2-47ce-bc41-d5436c772b3f" }, { "id": "106a8e3f-4573-4e11-8682-b322e884d0eb", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transcript\": [\n {\n \"role\": \"tool\",\n \"content\": \"\",\n \"message\": \"\",\n \"tool_calls\": [\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"function\",\n \"function\": {\n \"name\": \"\",\n \"arguments\": \"\"\n }\n }\n ],\n \"tool_call_id\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"timestamp\": \"\",\n \"firstWordStart\": \"\",\n \"lastWordEnd\": \"\"\n }\n ],\n \"audio_url\": \"\",\n \"upload_id\": \"upl_QR3Y031NYFCW72GG1HDR4RC21E\",\n \"metrics\": [\n \"\",\n \"\"\n ],\n \"metadata\": {\n \"est3f\": -34597920.42481649,\n \"Excepteur6\": \"culpa ut in sit\",\n \"dolorcc\": true,\n \"ut65\": \"la\"\n },\n \"tags\": [\n \"L[c4bqCXO 9!1Qq\",\n \"&a9%.&]{/\\\\qx\"\n ],\n \"external_conversation_id\": \"\",\n \"occurred_at\": \"\",\n \"agent_id\": \"t8vaDV3n7UP9x3aVUnVLgU\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations:submit", "host": [ "{{baseUrl}}" ], "path": [ "conversations:submit" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-106a8e3f-4573-4e11-8682-b322e884d0eb" } ], "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-2d9a43b0-e591-44a7-a7d3-7a0640827fd1" } ], "id": "51c69650-6f0b-4b44-9993-e0c5181d6f6c", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-51c69650-6f0b-4b44-9993-e0c5181d6f6c" }, { "name": "conversations", "item": [ { "name": "{conversation_id}", "item": [ { "name": "metrics", "item": [ { "name": "{metric_output_id}", "item": [ { "name": "Get conversation metric output(s)", "id": "f5d081e9-c38b-4c84-bbb0-626bfda6dec0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id/metrics/:metric_output_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id", "metrics", ":metric_output_id" ], "variable": [ { "id": "5083d776-dfbf-483a-9805-f8c97753805f", "key": "conversation_id", "value": "", "description": "(Required) Unique conversation identifier" }, { "id": "3713dd59-33e3-41a3-9ffc-605e2174d356", "key": "metric_output_id", "value": "", "description": "(Required) Either a 26-char MetricOutput ULID or a 22-char Metric definition ID.\nSee endpoint description for response shape per ID type.\n" } ] }, "description": "Retrieve metric output(s) for a conversation by ID. The path segment\naccepts two ID types and returns different response shapes:\n\n- **26-char MetricOutput ULID** (e.g. `01JCQR8Z9PQSTNVWXY12345678`):\n returns a single metric output as `{ \"metric\": {...} }`.\n- **22-char Metric definition ID** (e.g. `29BlkepvvX19ebbLDB0y6Q`):\n returns every output for that metric on the conversation as\n `{ \"metric_outputs\": [...] }`.\n\nClients should branch on the input ID length they passed.\n\nThis endpoint serves **monitoring conversations only**. To retrieve\nresults for a simulation \u2014 including test-metric results from\n`POST /v1/metrics/{metric_id}/test` \u2014 use\n`GET /v1/simulations/{simulation_id}/metrics/{metric_output_id}` instead.\n" }, "response": [ { "id": "d261a463-4df2-411b-86c0-2f72485302f7", "name": "Metric output details. Single object when called with a 26-char\nULID, collection object when called with a 22-char metric_id.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id/metrics/:metric_output_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id", "metrics", ":metric_output_id" ], "variable": [ { "key": "conversation_id" }, { "key": "metric_output_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"metric\": {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"IN QUEUE\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"ipsum_8a7\": \"magna aliquip tempor nulla ad\",\n \"est9\": 73017300.3899853,\n \"pariatur_172\": false\n }\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-d261a463-4df2-411b-86c0-2f72485302f7" }, { "id": "a3cc1a0f-88a2-41ab-bf1e-3d61a5c58f5e", "name": "Missing or invalid API key", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id/metrics/:metric_output_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id", "metrics", ":metric_output_id" ], "variable": [ { "key": "conversation_id" }, { "key": "metric_output_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-a3cc1a0f-88a2-41ab-bf1e-3d61a5c58f5e" }, { "id": "8655e3e8-8116-4cc6-be4b-b4b16ea5107c", "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id/metrics/:metric_output_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id", "metrics", ":metric_output_id" ], "variable": [ { "key": "conversation_id" }, { "key": "metric_output_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-8655e3e8-8116-4cc6-be4b-b4b16ea5107c" }, { "id": "32d2eb0f-cf5e-485c-8b8e-8bee667d40c9", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id/metrics/:metric_output_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id", "metrics", ":metric_output_id" ], "variable": [ { "key": "conversation_id" }, { "key": "metric_output_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-32d2eb0f-cf5e-485c-8b8e-8bee667d40c9" } ], "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-f5d081e9-c38b-4c84-bbb0-626bfda6dec0" } ], "id": "bf3010b6-17ed-4be8-a9a2-2335435ba1fe", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-bf3010b6-17ed-4be8-a9a2-2335435ba1fe" }, { "name": "List conversation metrics", "id": "69d19f73-cf67-4b5f-b0bd-9786046be3a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id/metrics?filter=&page_size=50&page_token=&order_by=metric_name", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id", "metrics" ], "query": [ { "description": "Filter expression syntax.\n\nValues may be unquoted or double-quoted. Values containing spaces must be quoted.\n\n**Supported fields:**\n- `metric_name` (string): Filter by metric name (e.g., `metric_name=latency`)\n- `status` (string): Filter by status (e.g., `status=COMPLETED`)\n- `output_type` (string): Filter by type (e.g., `output_type=float`)\n\n**Examples:**\n- `filter=status=COMPLETED`\n- `filter=metric_name=latency AND status=COMPLETED`\n- `filter=output_type=float`\n", "key": "filter", "value": "" }, { "description": "Maximum number of metrics to return (1-1000)", "key": "page_size", "value": "50" }, { "description": "Pagination token from previous response (for fetching next page)", "key": "page_token", "value": "" }, { "description": "Field to order results by.\n\n**Supported fields:**\n- `metric_name` (default): Sort by metric name alphabetically\n- `create_time`: Sort by creation time\n- `start_time`: Sort by computation start time\n- `end_time`: Sort by computation end time\n- `value`: Sort by metric value (float types only)\n\n**Prefix with `-` for descending order** (e.g., `-create_time`)\n", "key": "order_by", "value": "metric_name" } ], "variable": [ { "id": "ae98fe7c-161a-48e8-b5e9-609829dfcf8f", "key": "conversation_id", "value": "", "description": "(Required) Unique conversation identifier" } ] }, "description": "List all metrics computed for a specific conversation.\n" }, "response": [ { "id": "e339f62e-0fc6-40d3-8d32-3335c054d158", "name": "List of metrics", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id/metrics?filter=&page_size=50&page_token=&order_by=metric_name", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id", "metrics" ], "query": [ { "description": "Filter expression syntax.\n\nValues may be unquoted or double-quoted. Values containing spaces must be quoted.\n\n**Supported fields:**\n- `metric_name` (string): Filter by metric name (e.g., `metric_name=latency`)\n- `status` (string): Filter by status (e.g., `status=COMPLETED`)\n- `output_type` (string): Filter by type (e.g., `output_type=float`)\n\n**Examples:**\n- `filter=status=COMPLETED`\n- `filter=metric_name=latency AND status=COMPLETED`\n- `filter=output_type=float`\n", "key": "filter", "value": "" }, { "description": "Maximum number of metrics to return (1-1000)", "key": "page_size", "value": "50" }, { "description": "Pagination token from previous response (for fetching next page)", "key": "page_token", "value": "" }, { "description": "Field to order results by.\n\n**Supported fields:**\n- `metric_name` (default): Sort by metric name alphabetically\n- `create_time`: Sort by creation time\n- `start_time`: Sort by computation start time\n- `end_time`: Sort by computation end time\n- `value`: Sort by metric value (float types only)\n\n**Prefix with `-` for descending order** (e.g., `-create_time`)\n", "key": "order_by", "value": "metric_name" } ], "variable": [ { "key": "conversation_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"metrics\": [\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"IN QUEUE\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"magna_691\": true,\n \"nisi_10\": 88184781,\n \"ut_0a9\": -71346066.31624255\n }\n },\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"FAILED\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"ea2\": -81859771.36189386\n }\n }\n ],\n \"next_page_token\": \"\"\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-e339f62e-0fc6-40d3-8d32-3335c054d158" }, { "id": "df01f37a-8369-41f7-b6f2-c3426541c061", "name": "Invalid request arguments", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id/metrics?filter=&page_size=50&page_token=&order_by=metric_name", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id", "metrics" ], "query": [ { "description": "Filter expression syntax.\n\nValues may be unquoted or double-quoted. Values containing spaces must be quoted.\n\n**Supported fields:**\n- `metric_name` (string): Filter by metric name (e.g., `metric_name=latency`)\n- `status` (string): Filter by status (e.g., `status=COMPLETED`)\n- `output_type` (string): Filter by type (e.g., `output_type=float`)\n\n**Examples:**\n- `filter=status=COMPLETED`\n- `filter=metric_name=latency AND status=COMPLETED`\n- `filter=output_type=float`\n", "key": "filter", "value": "" }, { "description": "Maximum number of metrics to return (1-1000)", "key": "page_size", "value": "50" }, { "description": "Pagination token from previous response (for fetching next page)", "key": "page_token", "value": "" }, { "description": "Field to order results by.\n\n**Supported fields:**\n- `metric_name` (default): Sort by metric name alphabetically\n- `create_time`: Sort by creation time\n- `start_time`: Sort by computation start time\n- `end_time`: Sort by computation end time\n- `value`: Sort by metric value (float types only)\n\n**Prefix with `-` for descending order** (e.g., `-create_time`)\n", "key": "order_by", "value": "metric_name" } ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-df01f37a-8369-41f7-b6f2-c3426541c061" }, { "id": "6fc81707-c634-4cbe-8822-fc942c166d8c", "name": "Missing or invalid API key", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id/metrics?filter=&page_size=50&page_token=&order_by=metric_name", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id", "metrics" ], "query": [ { "description": "Filter expression syntax.\n\nValues may be unquoted or double-quoted. Values containing spaces must be quoted.\n\n**Supported fields:**\n- `metric_name` (string): Filter by metric name (e.g., `metric_name=latency`)\n- `status` (string): Filter by status (e.g., `status=COMPLETED`)\n- `output_type` (string): Filter by type (e.g., `output_type=float`)\n\n**Examples:**\n- `filter=status=COMPLETED`\n- `filter=metric_name=latency AND status=COMPLETED`\n- `filter=output_type=float`\n", "key": "filter", "value": "" }, { "description": "Maximum number of metrics to return (1-1000)", "key": "page_size", "value": "50" }, { "description": "Pagination token from previous response (for fetching next page)", "key": "page_token", "value": "" }, { "description": "Field to order results by.\n\n**Supported fields:**\n- `metric_name` (default): Sort by metric name alphabetically\n- `create_time`: Sort by creation time\n- `start_time`: Sort by computation start time\n- `end_time`: Sort by computation end time\n- `value`: Sort by metric value (float types only)\n\n**Prefix with `-` for descending order** (e.g., `-create_time`)\n", "key": "order_by", "value": "metric_name" } ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-6fc81707-c634-4cbe-8822-fc942c166d8c" }, { "id": "dacc41ba-2413-4b47-875d-16479af2e82c", "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id/metrics?filter=&page_size=50&page_token=&order_by=metric_name", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id", "metrics" ], "query": [ { "description": "Filter expression syntax.\n\nValues may be unquoted or double-quoted. Values containing spaces must be quoted.\n\n**Supported fields:**\n- `metric_name` (string): Filter by metric name (e.g., `metric_name=latency`)\n- `status` (string): Filter by status (e.g., `status=COMPLETED`)\n- `output_type` (string): Filter by type (e.g., `output_type=float`)\n\n**Examples:**\n- `filter=status=COMPLETED`\n- `filter=metric_name=latency AND status=COMPLETED`\n- `filter=output_type=float`\n", "key": "filter", "value": "" }, { "description": "Maximum number of metrics to return (1-1000)", "key": "page_size", "value": "50" }, { "description": "Pagination token from previous response (for fetching next page)", "key": "page_token", "value": "" }, { "description": "Field to order results by.\n\n**Supported fields:**\n- `metric_name` (default): Sort by metric name alphabetically\n- `create_time`: Sort by creation time\n- `start_time`: Sort by computation start time\n- `end_time`: Sort by computation end time\n- `value`: Sort by metric value (float types only)\n\n**Prefix with `-` for descending order** (e.g., `-create_time`)\n", "key": "order_by", "value": "metric_name" } ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-dacc41ba-2413-4b47-875d-16479af2e82c" }, { "id": "2642b6bf-0acc-4a67-886a-84cea1047619", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id/metrics?filter=&page_size=50&page_token=&order_by=metric_name", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id", "metrics" ], "query": [ { "description": "Filter expression syntax.\n\nValues may be unquoted or double-quoted. Values containing spaces must be quoted.\n\n**Supported fields:**\n- `metric_name` (string): Filter by metric name (e.g., `metric_name=latency`)\n- `status` (string): Filter by status (e.g., `status=COMPLETED`)\n- `output_type` (string): Filter by type (e.g., `output_type=float`)\n\n**Examples:**\n- `filter=status=COMPLETED`\n- `filter=metric_name=latency AND status=COMPLETED`\n- `filter=output_type=float`\n", "key": "filter", "value": "" }, { "description": "Maximum number of metrics to return (1-1000)", "key": "page_size", "value": "50" }, { "description": "Pagination token from previous response (for fetching next page)", "key": "page_token", "value": "" }, { "description": "Field to order results by.\n\n**Supported fields:**\n- `metric_name` (default): Sort by metric name alphabetically\n- `create_time`: Sort by creation time\n- `start_time`: Sort by computation start time\n- `end_time`: Sort by computation end time\n- `value`: Sort by metric value (float types only)\n\n**Prefix with `-` for descending order** (e.g., `-create_time`)\n", "key": "order_by", "value": "metric_name" } ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-2642b6bf-0acc-4a67-886a-84cea1047619" } ], "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-69d19f73-cf67-4b5f-b0bd-9786046be3a2" } ], "id": "b80baabf-59c7-4537-a834-151de1c14b19", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-b80baabf-59c7-4537-a834-151de1c14b19" }, { "name": "Get conversation details", "id": "7b7f2430-562a-42ea-9ffa-cf10ffc26868", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id?include_progress=true", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "query": [ { "description": "Include progress tracking information", "key": "include_progress", "value": "true" } ], "variable": [ { "id": "a0ce72ad-73d6-4bf8-920d-ac032b4b241c", "key": "conversation_id", "value": "", "description": "(Required) Unique conversation identifier (22-26 characters)" } ] }, "description": "Retrieve detailed information about a specific conversation.\n" }, "response": [ { "id": "bd7428d4-79c4-48f4-bed4-3a3079a3f07c", "name": "Conversation details", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id?include_progress=true", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "query": [ { "description": "Include progress tracking information", "key": "include_progress", "value": "true" } ], "variable": [ { "key": "conversation_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"conversation\": {\n \"name\": \"\",\n \"conversation_id\": \"\",\n \"status\": \"PENDING\",\n \"create_time\": \"\",\n \"external_conversation_id\": \"\",\n \"occurred_at\": \"\",\n \"has_audio\": \"\",\n \"agent_id\": \"rWGdUZQiiQxzKDu9aoUroz\",\n \"persona_id\": \"\",\n \"source\": {\n \"type\": \"phone\",\n \"value\": \"\"\n },\n \"destination\": {\n \"type\": \"phone\",\n \"value\": \"\"\n },\n \"progress\": {\n \"total_metrics\": \"\",\n \"completed_metrics\": \"\",\n \"failed_metrics\": \"\",\n \"in_progress_metrics\": \"\"\n },\n \"metadata\": {\n \"velit4\": 85154569,\n \"Excepteurb41\": true,\n \"eu_0\": \"magna fugiat occaecat\",\n \"et__\": 88311899\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"metric_ids\": [\n \"\",\n \"\"\n ],\n \"metric_outputs\": [\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"COMPLETED\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"eu_276\": 53899810\n }\n },\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"COMPLETED\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"labore_0\": -65549726,\n \"elit_5e\": 12179637\n }\n }\n ],\n \"error\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-bd7428d4-79c4-48f4-bed4-3a3079a3f07c" }, { "id": "e6aeb591-6dbc-4a28-879f-447805f11f9a", "name": "Missing or invalid API key", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id?include_progress=true", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "query": [ { "description": "Include progress tracking information", "key": "include_progress", "value": "true" } ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-e6aeb591-6dbc-4a28-879f-447805f11f9a" }, { "id": "57c53b14-1b66-41ba-8584-622ae3301dd7", "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id?include_progress=true", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "query": [ { "description": "Include progress tracking information", "key": "include_progress", "value": "true" } ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-57c53b14-1b66-41ba-8584-622ae3301dd7" }, { "id": "916a3e84-00b3-4bce-a746-37e6f01a2e1e", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id?include_progress=true", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "query": [ { "description": "Include progress tracking information", "key": "include_progress", "value": "true" } ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-916a3e84-00b3-4bce-a746-37e6f01a2e1e" } ], "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-7b7f2430-562a-42ea-9ffa-cf10ffc26868" }, { "name": "Delete or cancel conversation", "id": "100eaa1b-3112-49a5-b868-c5463ba717a8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "variable": [ { "id": "46ae5664-1cf8-406d-92e5-94f1327a8d41", "key": "conversation_id", "value": "", "description": "(Required) Unique conversation identifier" } ] }, "description": "Delete or cancel a conversation evaluation.\n" }, "response": [ { "id": "39f96b8c-f83b-4da2-8fe5-95a638692a80", "name": "Conversation deleted or cancelled successfully", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "variable": [ { "key": "conversation_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"conversation\": {\n \"name\": \"\",\n \"conversation_id\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"create_time\": \"\",\n \"external_conversation_id\": \"\",\n \"occurred_at\": \"\",\n \"has_audio\": \"\",\n \"agent_id\": \"Rok2VBhEGeFRYYPRXoHtST\",\n \"persona_id\": \"\",\n \"source\": {\n \"type\": \"phone\",\n \"value\": \"\"\n },\n \"destination\": {\n \"type\": \"phone\",\n \"value\": \"\"\n },\n \"progress\": {\n \"total_metrics\": \"\",\n \"completed_metrics\": \"\",\n \"failed_metrics\": \"\",\n \"in_progress_metrics\": \"\"\n },\n \"metadata\": {\n \"sit_aeb\": 63413144.720053226\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"metric_ids\": [\n \"\",\n \"\"\n ],\n \"metric_outputs\": [\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"COMPLETED\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"commodo4b0\": \"in magna\",\n \"cupidatatb\": 426100.4761566371\n }\n },\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"IN PROGRESS\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"veniamb\": -48374875.36061484,\n \"veniam7\": \"nisi\",\n \"elit_13f\": 31836937\n }\n }\n ],\n \"error\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-39f96b8c-f83b-4da2-8fe5-95a638692a80" }, { "id": "3b316aef-f282-4f6c-bfed-8eafba1d9f73", "name": "Missing or invalid API key", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-3b316aef-f282-4f6c-bfed-8eafba1d9f73" }, { "id": "6de99fe3-5788-40bf-b2d7-c693d1242b6c", "name": "Resource not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-6de99fe3-5788-40bf-b2d7-c693d1242b6c" }, { "id": "43a485f0-21ae-4a19-8e83-2b7ae9859110", "name": "Internal server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-43a485f0-21ae-4a19-8e83-2b7ae9859110" } ], "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-100eaa1b-3112-49a5-b868-c5463ba717a8" }, { "name": "Attach audio to a conversation", "id": "94c80132-1a2a-4ca2-9e5d-6856b039e3b1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"audio_url\": \"\",\n \"audio\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "variable": [ { "id": "8d3bae0a-dc44-4d9b-9bb5-c9b29c4f550c", "key": "conversation_id", "value": "", "description": "(Required) Unique conversation identifier (22-26 characters)" } ] }, "description": "Attach an audio recording to a conversation previously submitted via\n`POST /v1/conversations:submit` without audio, and trigger audio-dependent\nmetrics as a second wave.\n\n**When to use this endpoint**\n\nUse this endpoint when your recording URL is not available at the moment\nthe call ends (for example, Twilio Programmable Voice recordings that are\nonly fetchable after an asynchronous job completes ~60 seconds later).\nSubmit the transcript immediately at call end to get a `conversation_id`\nfor trace correlation, then PATCH the audio when the recording URL is\nready.\n\n**Two-wave metric timing**\n\n- Text-only metrics fire immediately after `POST /v1/conversations:submit`\n and deliver their results via your configured webhook.\n- Audio-dependent metrics fire after this PATCH and deliver a separate,\n later webhook. Configure your consumer to expect both waves.\n\n**One-shot**\n\nAudio can be attached only once per conversation. Overwriting is not\nsupported in v1 \u2014 a second PATCH on a conversation that already has\naudio returns `409 ALREADY_EXISTS`.\n\n**Body**\n\nExactly one of `audio` or `audio_url` is required.\n" }, "response": [ { "id": "90e4e563-3591-4adb-a732-39897c788080", "name": "Audio attached successfully; audio metrics queued", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"audio_url\": \"\",\n \"audio\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "variable": [ { "key": "conversation_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"conversation\": {\n \"name\": \"\",\n \"conversation_id\": \"\",\n \"status\": \"PENDING\",\n \"create_time\": \"\",\n \"external_conversation_id\": \"\",\n \"occurred_at\": \"\",\n \"has_audio\": \"\",\n \"agent_id\": \"rWGdUZQiiQxzKDu9aoUroz\",\n \"persona_id\": \"\",\n \"source\": {\n \"type\": \"phone\",\n \"value\": \"\"\n },\n \"destination\": {\n \"type\": \"phone\",\n \"value\": \"\"\n },\n \"progress\": {\n \"total_metrics\": \"\",\n \"completed_metrics\": \"\",\n \"failed_metrics\": \"\",\n \"in_progress_metrics\": \"\"\n },\n \"metadata\": {\n \"velit4\": 85154569,\n \"Excepteurb41\": true,\n \"eu_0\": \"magna fugiat occaecat\",\n \"et__\": 88311899\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"metric_ids\": [\n \"\",\n \"\"\n ],\n \"metric_outputs\": [\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"COMPLETED\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"eu_276\": 53899810\n }\n },\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"COMPLETED\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"labore_0\": -65549726,\n \"elit_5e\": 12179637\n }\n }\n ],\n \"error\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-90e4e563-3591-4adb-a732-39897c788080" }, { "id": "4559d142-8f01-479a-8b90-9ea735f9ff63", "name": "Invalid request arguments", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"audio_url\": \"\",\n \"audio\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-4559d142-8f01-479a-8b90-9ea735f9ff63" }, { "id": "9594fc03-8f9f-408b-af63-35c769d061d9", "name": "Missing or invalid API key", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"audio_url\": \"\",\n \"audio\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-9594fc03-8f9f-408b-af63-35c769d061d9" }, { "id": "9dde18f7-417b-471d-b191-e69014daca78", "name": "Resource not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"audio_url\": \"\",\n \"audio\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-9dde18f7-417b-471d-b191-e69014daca78" }, { "id": "eb2a4278-03cc-4195-ba51-c015cf41f21c", "name": "Audio is already attached to this conversation", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"audio_url\": \"\",\n \"audio\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-eb2a4278-03cc-4195-ba51-c015cf41f21c" }, { "id": "5ac42229-4a36-4a13-932b-73521fca77e0", "name": "Internal server error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"audio_url\": \"\",\n \"audio\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":conversation_id" ], "variable": [ { "key": "conversation_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-5ac42229-4a36-4a13-932b-73521fca77e0" } ], "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-94c80132-1a2a-4ca2-9e5d-6856b039e3b1" } ], "id": "6334d102-a9bd-4dd4-ae8b-e94b45f6d13c", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-6334d102-a9bd-4dd4-ae8b-e94b45f6d13c" }, { "name": "List conversations", "id": "7eb706d2-a397-487f-a09c-c3d5eed80a29", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/conversations?page_size=50&page_token=&filter=&order_by=-occurred_at&view=metric_breakdown&metric_id=&include=metric_outputs&group_by_metadata=&aggregation=avg&start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "conversations" ], "query": [ { "description": "Maximum number of conversations to return (1-250)", "key": "page_size", "value": "50" }, { "description": "Token for retrieving next page (from previous response)", "key": "page_token", "value": "" }, { "description": "Filter expression syntax.\n\n**Operators:** `=`, `!=`, `>`, `<`, `>=`, `<=`, `AND`, `OR`\n\nValues may be unquoted or double-quoted. Values containing spaces must be quoted.\n\n**Fields:**\n- `status` - PENDING, IN_QUEUE, IN_PROGRESS, COMPLETED, FAILED, CANCELLED, DELETED\n- `external_conversation_id` - Your system's conversation ID\n- `create_time` - ISO 8601 timestamp\n- `occurred_at` - ISO 8601 timestamp\n- `metadata.{key}` - Custom metadata fields\n\n**Examples:**\n- `status=COMPLETED`\n- `create_time>\"2025-11-01T00:00:00Z\"`\n- `status=COMPLETED AND occurred_at>=\"2025-11-01T00:00:00Z\"`\n- `external_conversation_id=external-call-abc`\n", "key": "filter", "value": "" }, { "description": "Sort field with optional `-` prefix for descending order.\n\n**Fields:** `create_time`, `occurred_at`, `status`\n\n**Examples:**\n- `create_time` (ascending)\n- `-create_time` (descending, most recent first)\n- `-occurred_at` (most recent conversations first)\n", "key": "order_by", "value": "-occurred_at" }, { "description": "Set to `metric_breakdown` to return an aggregate of one metric's scores\ngrouped by a `customer_metadata` key (e.g. vendor), computed over the whole\nscored monitoring corpus, instead of the conversation list. Requires\n`metric_id` and `group_by_metadata`; the response is a metric-breakdown object\n(`{view, metric_id, group_by_metadata, aggregation, breakdown:[{metadata_value,\nvalue, count}], total_count}`).\n", "key": "view", "value": "metric_breakdown" }, { "description": "Metric to aggregate when `view=metric_breakdown`, or the metric whose full\noutputs should be embedded when `include=metric_outputs`.\n", "key": "metric_id", "value": "" }, { "description": "Set to `metric_outputs` to embed full outputs for `metric_id` on every\nconversation in the returned page. Omitted by default to keep list payloads small.\n", "key": "include", "value": "metric_outputs" }, { "description": "Required when `view=metric_breakdown`: the customer_metadata key to group by (e.g. nlp_provider).", "key": "group_by_metadata", "value": "" }, { "description": "Aggregation for `view=metric_breakdown`. Defaults to `success` (a YES/NO\nsuccess rate) for binary/string metrics and `avg` (numeric mean) for float\nmetrics.\n", "key": "aggregation", "value": "avg" }, { "description": "Optional ISO-8601 lower bound (occurred_at) for `view=metric_breakdown`.", "key": "start_date", "value": "" }, { "description": "Optional ISO-8601 upper bound (occurred_at) for `view=metric_breakdown`.", "key": "end_date", "value": "" } ] }, "description": "List conversations with optional filtering, pagination, and ordering.\n" }, "response": [ { "id": "4e0ac32c-d434-4b56-a3e6-1886a312d023", "name": "List of conversations, or a metric breakdown when `view=metric_breakdown`", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations?page_size=50&page_token=&filter=&order_by=-occurred_at&view=metric_breakdown&metric_id=&include=metric_outputs&group_by_metadata=&aggregation=avg&start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "conversations" ], "query": [ { "description": "Maximum number of conversations to return (1-250)", "key": "page_size", "value": "50" }, { "description": "Token for retrieving next page (from previous response)", "key": "page_token", "value": "" }, { "description": "Filter expression syntax.\n\n**Operators:** `=`, `!=`, `>`, `<`, `>=`, `<=`, `AND`, `OR`\n\nValues may be unquoted or double-quoted. Values containing spaces must be quoted.\n\n**Fields:**\n- `status` - PENDING, IN_QUEUE, IN_PROGRESS, COMPLETED, FAILED, CANCELLED, DELETED\n- `external_conversation_id` - Your system's conversation ID\n- `create_time` - ISO 8601 timestamp\n- `occurred_at` - ISO 8601 timestamp\n- `metadata.{key}` - Custom metadata fields\n\n**Examples:**\n- `status=COMPLETED`\n- `create_time>\"2025-11-01T00:00:00Z\"`\n- `status=COMPLETED AND occurred_at>=\"2025-11-01T00:00:00Z\"`\n- `external_conversation_id=external-call-abc`\n", "key": "filter", "value": "" }, { "description": "Sort field with optional `-` prefix for descending order.\n\n**Fields:** `create_time`, `occurred_at`, `status`\n\n**Examples:**\n- `create_time` (ascending)\n- `-create_time` (descending, most recent first)\n- `-occurred_at` (most recent conversations first)\n", "key": "order_by", "value": "-occurred_at" }, { "description": "Set to `metric_breakdown` to return an aggregate of one metric's scores\ngrouped by a `customer_metadata` key (e.g. vendor), computed over the whole\nscored monitoring corpus, instead of the conversation list. Requires\n`metric_id` and `group_by_metadata`; the response is a metric-breakdown object\n(`{view, metric_id, group_by_metadata, aggregation, breakdown:[{metadata_value,\nvalue, count}], total_count}`).\n", "key": "view", "value": "metric_breakdown" }, { "description": "Metric to aggregate when `view=metric_breakdown`, or the metric whose full\noutputs should be embedded when `include=metric_outputs`.\n", "key": "metric_id", "value": "" }, { "description": "Set to `metric_outputs` to embed full outputs for `metric_id` on every\nconversation in the returned page. Omitted by default to keep list payloads small.\n", "key": "include", "value": "metric_outputs" }, { "description": "Required when `view=metric_breakdown`: the customer_metadata key to group by (e.g. nlp_provider).", "key": "group_by_metadata", "value": "" }, { "description": "Aggregation for `view=metric_breakdown`. Defaults to `success` (a YES/NO\nsuccess rate) for binary/string metrics and `avg` (numeric mean) for float\nmetrics.\n", "key": "aggregation", "value": "avg" }, { "description": "Optional ISO-8601 lower bound (occurred_at) for `view=metric_breakdown`.", "key": "start_date", "value": "" }, { "description": "Optional ISO-8601 upper bound (occurred_at) for `view=metric_breakdown`.", "key": "end_date", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"conversations\": [\n {\n \"name\": \"\",\n \"conversation_id\": \"\",\n \"status\": \"DELETED\",\n \"create_time\": \"\",\n \"external_conversation_id\": \"\",\n \"occurred_at\": \"\",\n \"has_audio\": \"\",\n \"agent_id\": \"8VEnagr4C2HjBipdGL6WqN\",\n \"persona_id\": \"\",\n \"source\": {\n \"type\": \"phone\",\n \"value\": \"\"\n },\n \"destination\": {\n \"type\": \"phone\",\n \"value\": \"\"\n },\n \"progress\": {\n \"total_metrics\": \"\",\n \"completed_metrics\": \"\",\n \"failed_metrics\": \"\",\n \"in_progress_metrics\": \"\"\n },\n \"metadata\": {\n \"ipsum_88\": \"minim irure cillum\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"metric_ids\": [\n \"\",\n \"\"\n ],\n \"metric_outputs\": [\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"FAILED\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"ut_1d\": 17658289\n }\n },\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"IN QUEUE\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"nulla_19\": -45967700.7049967,\n \"laboris_653\": 56316188.377096355,\n \"laboris_89d\": false\n }\n }\n ],\n \"error\": \"\"\n },\n {\n \"name\": \"\",\n \"conversation_id\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"create_time\": \"\",\n \"external_conversation_id\": \"\",\n \"occurred_at\": \"\",\n \"has_audio\": \"\",\n \"agent_id\": \"cfruvsBSTvjZivHAfGSVpC\",\n \"persona_id\": \"\",\n \"source\": {\n \"type\": \"phone\",\n \"value\": \"\"\n },\n \"destination\": {\n \"type\": \"phone\",\n \"value\": \"\"\n },\n \"progress\": {\n \"total_metrics\": \"\",\n \"completed_metrics\": \"\",\n \"failed_metrics\": \"\",\n \"in_progress_metrics\": \"\"\n },\n \"metadata\": {\n \"autece7\": 43012741.40832123\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"metric_ids\": [\n \"\",\n \"\"\n ],\n \"metric_outputs\": [\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"IN PROGRESS\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"irure_a5\": true\n }\n },\n {\n \"metric_output_id\": \"\",\n \"metric_id\": \"\",\n \"status\": \"IN QUEUE\",\n \"metric_version_ulid\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"result\": {\n \"Lorem06d\": \"veniam pariatur laboris cillum\",\n \"ut_ea\": -4606658,\n \"tempor3\": 43623575,\n \"eu_f6\": 19560079\n }\n }\n ],\n \"error\": \"\"\n }\n ],\n \"next_page_token\": \"\"\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-4e0ac32c-d434-4b56-a3e6-1886a312d023" }, { "id": "cde69cb6-12b5-42f9-bdcf-8fa724e91ff2", "name": "Invalid request arguments", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations?page_size=50&page_token=&filter=&order_by=-occurred_at&view=metric_breakdown&metric_id=&include=metric_outputs&group_by_metadata=&aggregation=avg&start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "conversations" ], "query": [ { "description": "Maximum number of conversations to return (1-250)", "key": "page_size", "value": "50" }, { "description": "Token for retrieving next page (from previous response)", "key": "page_token", "value": "" }, { "description": "Filter expression syntax.\n\n**Operators:** `=`, `!=`, `>`, `<`, `>=`, `<=`, `AND`, `OR`\n\nValues may be unquoted or double-quoted. Values containing spaces must be quoted.\n\n**Fields:**\n- `status` - PENDING, IN_QUEUE, IN_PROGRESS, COMPLETED, FAILED, CANCELLED, DELETED\n- `external_conversation_id` - Your system's conversation ID\n- `create_time` - ISO 8601 timestamp\n- `occurred_at` - ISO 8601 timestamp\n- `metadata.{key}` - Custom metadata fields\n\n**Examples:**\n- `status=COMPLETED`\n- `create_time>\"2025-11-01T00:00:00Z\"`\n- `status=COMPLETED AND occurred_at>=\"2025-11-01T00:00:00Z\"`\n- `external_conversation_id=external-call-abc`\n", "key": "filter", "value": "" }, { "description": "Sort field with optional `-` prefix for descending order.\n\n**Fields:** `create_time`, `occurred_at`, `status`\n\n**Examples:**\n- `create_time` (ascending)\n- `-create_time` (descending, most recent first)\n- `-occurred_at` (most recent conversations first)\n", "key": "order_by", "value": "-occurred_at" }, { "description": "Set to `metric_breakdown` to return an aggregate of one metric's scores\ngrouped by a `customer_metadata` key (e.g. vendor), computed over the whole\nscored monitoring corpus, instead of the conversation list. Requires\n`metric_id` and `group_by_metadata`; the response is a metric-breakdown object\n(`{view, metric_id, group_by_metadata, aggregation, breakdown:[{metadata_value,\nvalue, count}], total_count}`).\n", "key": "view", "value": "metric_breakdown" }, { "description": "Metric to aggregate when `view=metric_breakdown`, or the metric whose full\noutputs should be embedded when `include=metric_outputs`.\n", "key": "metric_id", "value": "" }, { "description": "Set to `metric_outputs` to embed full outputs for `metric_id` on every\nconversation in the returned page. Omitted by default to keep list payloads small.\n", "key": "include", "value": "metric_outputs" }, { "description": "Required when `view=metric_breakdown`: the customer_metadata key to group by (e.g. nlp_provider).", "key": "group_by_metadata", "value": "" }, { "description": "Aggregation for `view=metric_breakdown`. Defaults to `success` (a YES/NO\nsuccess rate) for binary/string metrics and `avg` (numeric mean) for float\nmetrics.\n", "key": "aggregation", "value": "avg" }, { "description": "Optional ISO-8601 lower bound (occurred_at) for `view=metric_breakdown`.", "key": "start_date", "value": "" }, { "description": "Optional ISO-8601 upper bound (occurred_at) for `view=metric_breakdown`.", "key": "end_date", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-cde69cb6-12b5-42f9-bdcf-8fa724e91ff2" }, { "id": "f81c9ec9-b4f3-4608-b13f-119cdace047a", "name": "Missing or invalid API key", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations?page_size=50&page_token=&filter=&order_by=-occurred_at&view=metric_breakdown&metric_id=&include=metric_outputs&group_by_metadata=&aggregation=avg&start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "conversations" ], "query": [ { "description": "Maximum number of conversations to return (1-250)", "key": "page_size", "value": "50" }, { "description": "Token for retrieving next page (from previous response)", "key": "page_token", "value": "" }, { "description": "Filter expression syntax.\n\n**Operators:** `=`, `!=`, `>`, `<`, `>=`, `<=`, `AND`, `OR`\n\nValues may be unquoted or double-quoted. Values containing spaces must be quoted.\n\n**Fields:**\n- `status` - PENDING, IN_QUEUE, IN_PROGRESS, COMPLETED, FAILED, CANCELLED, DELETED\n- `external_conversation_id` - Your system's conversation ID\n- `create_time` - ISO 8601 timestamp\n- `occurred_at` - ISO 8601 timestamp\n- `metadata.{key}` - Custom metadata fields\n\n**Examples:**\n- `status=COMPLETED`\n- `create_time>\"2025-11-01T00:00:00Z\"`\n- `status=COMPLETED AND occurred_at>=\"2025-11-01T00:00:00Z\"`\n- `external_conversation_id=external-call-abc`\n", "key": "filter", "value": "" }, { "description": "Sort field with optional `-` prefix for descending order.\n\n**Fields:** `create_time`, `occurred_at`, `status`\n\n**Examples:**\n- `create_time` (ascending)\n- `-create_time` (descending, most recent first)\n- `-occurred_at` (most recent conversations first)\n", "key": "order_by", "value": "-occurred_at" }, { "description": "Set to `metric_breakdown` to return an aggregate of one metric's scores\ngrouped by a `customer_metadata` key (e.g. vendor), computed over the whole\nscored monitoring corpus, instead of the conversation list. Requires\n`metric_id` and `group_by_metadata`; the response is a metric-breakdown object\n(`{view, metric_id, group_by_metadata, aggregation, breakdown:[{metadata_value,\nvalue, count}], total_count}`).\n", "key": "view", "value": "metric_breakdown" }, { "description": "Metric to aggregate when `view=metric_breakdown`, or the metric whose full\noutputs should be embedded when `include=metric_outputs`.\n", "key": "metric_id", "value": "" }, { "description": "Set to `metric_outputs` to embed full outputs for `metric_id` on every\nconversation in the returned page. Omitted by default to keep list payloads small.\n", "key": "include", "value": "metric_outputs" }, { "description": "Required when `view=metric_breakdown`: the customer_metadata key to group by (e.g. nlp_provider).", "key": "group_by_metadata", "value": "" }, { "description": "Aggregation for `view=metric_breakdown`. Defaults to `success` (a YES/NO\nsuccess rate) for binary/string metrics and `avg` (numeric mean) for float\nmetrics.\n", "key": "aggregation", "value": "avg" }, { "description": "Optional ISO-8601 lower bound (occurred_at) for `view=metric_breakdown`.", "key": "start_date", "value": "" }, { "description": "Optional ISO-8601 upper bound (occurred_at) for `view=metric_breakdown`.", "key": "end_date", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-f81c9ec9-b4f3-4608-b13f-119cdace047a" }, { "id": "a665c2aa-4fd9-4525-b12e-9665d7c69041", "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations?page_size=50&page_token=&filter=&order_by=-occurred_at&view=metric_breakdown&metric_id=&include=metric_outputs&group_by_metadata=&aggregation=avg&start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "conversations" ], "query": [ { "description": "Maximum number of conversations to return (1-250)", "key": "page_size", "value": "50" }, { "description": "Token for retrieving next page (from previous response)", "key": "page_token", "value": "" }, { "description": "Filter expression syntax.\n\n**Operators:** `=`, `!=`, `>`, `<`, `>=`, `<=`, `AND`, `OR`\n\nValues may be unquoted or double-quoted. Values containing spaces must be quoted.\n\n**Fields:**\n- `status` - PENDING, IN_QUEUE, IN_PROGRESS, COMPLETED, FAILED, CANCELLED, DELETED\n- `external_conversation_id` - Your system's conversation ID\n- `create_time` - ISO 8601 timestamp\n- `occurred_at` - ISO 8601 timestamp\n- `metadata.{key}` - Custom metadata fields\n\n**Examples:**\n- `status=COMPLETED`\n- `create_time>\"2025-11-01T00:00:00Z\"`\n- `status=COMPLETED AND occurred_at>=\"2025-11-01T00:00:00Z\"`\n- `external_conversation_id=external-call-abc`\n", "key": "filter", "value": "" }, { "description": "Sort field with optional `-` prefix for descending order.\n\n**Fields:** `create_time`, `occurred_at`, `status`\n\n**Examples:**\n- `create_time` (ascending)\n- `-create_time` (descending, most recent first)\n- `-occurred_at` (most recent conversations first)\n", "key": "order_by", "value": "-occurred_at" }, { "description": "Set to `metric_breakdown` to return an aggregate of one metric's scores\ngrouped by a `customer_metadata` key (e.g. vendor), computed over the whole\nscored monitoring corpus, instead of the conversation list. Requires\n`metric_id` and `group_by_metadata`; the response is a metric-breakdown object\n(`{view, metric_id, group_by_metadata, aggregation, breakdown:[{metadata_value,\nvalue, count}], total_count}`).\n", "key": "view", "value": "metric_breakdown" }, { "description": "Metric to aggregate when `view=metric_breakdown`, or the metric whose full\noutputs should be embedded when `include=metric_outputs`.\n", "key": "metric_id", "value": "" }, { "description": "Set to `metric_outputs` to embed full outputs for `metric_id` on every\nconversation in the returned page. Omitted by default to keep list payloads small.\n", "key": "include", "value": "metric_outputs" }, { "description": "Required when `view=metric_breakdown`: the customer_metadata key to group by (e.g. nlp_provider).", "key": "group_by_metadata", "value": "" }, { "description": "Aggregation for `view=metric_breakdown`. Defaults to `success` (a YES/NO\nsuccess rate) for binary/string metrics and `avg` (numeric mean) for float\nmetrics.\n", "key": "aggregation", "value": "avg" }, { "description": "Optional ISO-8601 lower bound (occurred_at) for `view=metric_breakdown`.", "key": "start_date", "value": "" }, { "description": "Optional ISO-8601 upper bound (occurred_at) for `view=metric_breakdown`.", "key": "end_date", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-a665c2aa-4fd9-4525-b12e-9665d7c69041" }, { "id": "7322cb1d-2c0d-4758-b882-b203586d3843", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/conversations?page_size=50&page_token=&filter=&order_by=-occurred_at&view=metric_breakdown&metric_id=&include=metric_outputs&group_by_metadata=&aggregation=avg&start_date=&end_date=", "host": [ "{{baseUrl}}" ], "path": [ "conversations" ], "query": [ { "description": "Maximum number of conversations to return (1-250)", "key": "page_size", "value": "50" }, { "description": "Token for retrieving next page (from previous response)", "key": "page_token", "value": "" }, { "description": "Filter expression syntax.\n\n**Operators:** `=`, `!=`, `>`, `<`, `>=`, `<=`, `AND`, `OR`\n\nValues may be unquoted or double-quoted. Values containing spaces must be quoted.\n\n**Fields:**\n- `status` - PENDING, IN_QUEUE, IN_PROGRESS, COMPLETED, FAILED, CANCELLED, DELETED\n- `external_conversation_id` - Your system's conversation ID\n- `create_time` - ISO 8601 timestamp\n- `occurred_at` - ISO 8601 timestamp\n- `metadata.{key}` - Custom metadata fields\n\n**Examples:**\n- `status=COMPLETED`\n- `create_time>\"2025-11-01T00:00:00Z\"`\n- `status=COMPLETED AND occurred_at>=\"2025-11-01T00:00:00Z\"`\n- `external_conversation_id=external-call-abc`\n", "key": "filter", "value": "" }, { "description": "Sort field with optional `-` prefix for descending order.\n\n**Fields:** `create_time`, `occurred_at`, `status`\n\n**Examples:**\n- `create_time` (ascending)\n- `-create_time` (descending, most recent first)\n- `-occurred_at` (most recent conversations first)\n", "key": "order_by", "value": "-occurred_at" }, { "description": "Set to `metric_breakdown` to return an aggregate of one metric's scores\ngrouped by a `customer_metadata` key (e.g. vendor), computed over the whole\nscored monitoring corpus, instead of the conversation list. Requires\n`metric_id` and `group_by_metadata`; the response is a metric-breakdown object\n(`{view, metric_id, group_by_metadata, aggregation, breakdown:[{metadata_value,\nvalue, count}], total_count}`).\n", "key": "view", "value": "metric_breakdown" }, { "description": "Metric to aggregate when `view=metric_breakdown`, or the metric whose full\noutputs should be embedded when `include=metric_outputs`.\n", "key": "metric_id", "value": "" }, { "description": "Set to `metric_outputs` to embed full outputs for `metric_id` on every\nconversation in the returned page. Omitted by default to keep list payloads small.\n", "key": "include", "value": "metric_outputs" }, { "description": "Required when `view=metric_breakdown`: the customer_metadata key to group by (e.g. nlp_provider).", "key": "group_by_metadata", "value": "" }, { "description": "Aggregation for `view=metric_breakdown`. Defaults to `success` (a YES/NO\nsuccess rate) for binary/string metrics and `avg` (numeric mean) for float\nmetrics.\n", "key": "aggregation", "value": "avg" }, { "description": "Optional ISO-8601 lower bound (occurred_at) for `view=metric_breakdown`.", "key": "start_date", "value": "" }, { "description": "Optional ISO-8601 upper bound (occurred_at) for `view=metric_breakdown`.", "key": "end_date", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-7322cb1d-2c0d-4758-b882-b203586d3843" } ], "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-7eb706d2-a397-487f-a09c-c3d5eed80a29" } ], "id": "47d610f8-55e9-478e-9225-6860499fefbd", "createdAt": "2026-07-28T01:26:30.000Z", "updatedAt": "2026-07-28T01:26:30.000Z", "uid": "35240-47d610f8-55e9-478e-9225-6860499fefbd" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.coval.dev/v1" } ] }