{"openapi":"3.1.0","info":{"title":"Retell AI Testing (BYOK) API","version":"0.1.0","description":"Retell AI Testing (BYOK) lets an AI assistant read your own Retell AI Testing data through the Retell AI Testing API with a key you supply (API key). Read-only: 5 tools (list_test_case_definitions, list_batch_tests, get_batch_test, list_test_runs, get_test_run). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-retell-testing.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-retell-testing/docs"},"termsOfService":"https://connectorbay.com/byok-retell-testing/terms"},"servers":[{"url":"https://byok-retell-testing.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-retell-testing/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_test_case_definitions":{"post":{"operationId":"list_test_case_definitions","summary":"List simulation test case definitions for a Retell LLM or conversation flow with name, metrics, model and timestamps (th","description":"List simulation test case definitions for a Retell LLM or conversation flow with name, metrics, model and timestamps (the simulated user prompt is not returned). Use for \"Which test cases are defined for my Retell LLM\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"description":"Which kind of response engine the tests belong to: retell-llm or conversation-flow.","enum":["retell-llm","conversation-flow"],"title":"Type","type":"string"},"llm_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Retell LLM id (required when type is retell-llm).","title":"Llm Id"},"conversation_flow_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Conversation flow id (required when type is conversation-flow).","title":"Conversation Flow Id"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 1000).","title":"Limit"},"pagination_key":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"The pagination_key of the previous answer to get the next page (leave empty for the first page).","title":"Pagination Key"}},"required":["type"],"title":"list_test_case_definitionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_batch_tests":{"post":{"operationId":"list_batch_tests","summary":"List batch test jobs for a Retell LLM or conversation flow with status and counts of passed, failed, errored and total t","description":"List batch test jobs for a Retell LLM or conversation flow with status and counts of passed, failed, errored and total test cases. Use for \"How did my latest Retell batch tests do\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"description":"Which kind of response engine the tests belong to: retell-llm or conversation-flow.","enum":["retell-llm","conversation-flow"],"title":"Type","type":"string"},"llm_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Retell LLM id (required when type is retell-llm).","title":"Llm Id"},"conversation_flow_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Conversation flow id (required when type is conversation-flow).","title":"Conversation Flow Id"},"version":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Response engine version to list tests for (defaults to latest).","title":"Version"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 1000).","title":"Limit"},"pagination_key":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"The pagination_key of the previous answer to get the next page (leave empty for the first page).","title":"Pagination Key"}},"required":["type"],"title":"list_batch_testsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_batch_test":{"post":{"operationId":"get_batch_test","summary":"Get one batch test job: status and counts of passed, failed, errored and total test cases. Use for \"What was the result ","description":"Get one batch test job: status and counts of passed, failed, errored and total test cases. Use for \"What was the result of this Retell batch test\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"test_case_batch_job_id":{"description":"Batch test job id from list_batch_tests.","maxLength":200,"title":"Test Case Batch Job Id","type":"string"}},"required":["test_case_batch_job_id"],"title":"get_batch_testArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_test_runs":{"post":{"operationId":"list_test_runs","summary":"List the individual test runs of a batch test job with status (pending, in_progress, pass, fail, error), test case id an","description":"List the individual test runs of a batch test job with status (pending, in_progress, pass, fail, error), test case id and result explanation (transcripts are not returned). Use for \"Which test cases failed in this Retell batch test and why\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"test_case_batch_job_id":{"description":"Batch test job id from list_batch_tests.","maxLength":200,"title":"Test Case Batch Job Id","type":"string"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 1000).","title":"Limit"},"pagination_key":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"The pagination_key of the previous answer to get the next page (leave empty for the first page).","title":"Pagination Key"}},"required":["test_case_batch_job_id"],"title":"list_test_runsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_test_run":{"post":{"operationId":"get_test_run","summary":"Get one test run: status, test case id, result explanation and timestamps (the transcript snapshot is not returned). Use","description":"Get one test run: status, test case id, result explanation and timestamps (the transcript snapshot is not returned). Use for \"Why did this Retell test run fail\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"test_case_job_id":{"description":"Test run id from list_test_runs.","maxLength":200,"title":"Test Case Job Id","type":"string"}},"required":["test_case_job_id"],"title":"get_test_runArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}