{"openapi":"3.1.0","info":{"title":"Retell AI (BYOK) API","version":"0.1.0","description":"Retell AI (BYOK) lets an AI assistant read your own Retell AI data through the Retell AI API with a key you supply (API key). Read-only: 9 tools (list_calls, get_call, list_chats, list_agents, get_agent, list_phone_numbers, list_voices, list_retell_llms, list_knowledge_bases). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-retell.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-retell/docs"},"termsOfService":"https://connectorbay.com/byok-retell/terms"},"servers":[{"url":"https://byok-retell.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-retell/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_calls":{"post":{"operationId":"list_calls","summary":"List calls (phone and web), newest first, with agent, direction, status, timing, duration, disconnection reason, analysi","description":"List calls (phone and web), newest first, with agent, direction, status, timing, duration, disconnection reason, analysis summary and cost. Transcripts are not included; use get_call for one call. Use for \"What calls did my Retell agents handle recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sort_order":{"anyOf":[{"enum":["ascending","descending"],"type":"string"},{"type":"null"}],"default":"descending","description":"Order by creation: descending (newest first) or ascending.","title":"Sort Order"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"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"},"include_total":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to also return the total number of matches.","title":"Include Total"}},"title":"list_callsArguments","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_call":{"post":{"operationId":"get_call","summary":"Get one call with transcript, analysis (summary, sentiment, success), timing, cost and metadata. Use for \"Show the trans","description":"Get one call with transcript, analysis (summary, sentiment, success), timing, cost and metadata. Use for \"Show the transcript and summary of one Retell call\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"call_id":{"description":"Call ID as returned by list_calls (call_id).","maxLength":80,"title":"Call Id","type":"string"}},"required":["call_id"],"title":"get_callArguments","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_chats":{"post":{"operationId":"list_chats","summary":"List text chats (API and SMS), newest first, with agent, status, type, timing, cost and analysis. Use for \"Which chats d","description":"List text chats (API and SMS), newest first, with agent, status, type, timing, cost and analysis. Use for \"Which chats did my Retell chat agents have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sort_order":{"anyOf":[{"enum":["ascending","descending"],"type":"string"},{"type":"null"}],"default":"descending","description":"Order by creation: descending (newest first) or ascending.","title":"Sort Order"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"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"},"include_total":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to also return the total number of matches.","title":"Include Total"}},"title":"list_chatsArguments","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_agents":{"post":{"operationId":"list_agents","summary":"List voice and chat agents with name, channel, last modification time and tags. Use for \"Which Retell agents do I have\".","description":"List voice and chat agents with name, channel, last modification time and tags. Use for \"Which Retell agents do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many items to return (1 to 1000).","title":"Limit"},"sort_order":{"anyOf":[{"enum":["ascending","descending"],"type":"string"},{"type":"null"}],"default":"descending","description":"Order by creation: descending (newest first) or ascending.","title":"Sort Order"},"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"}},"title":"list_agentsArguments","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_agent":{"post":{"operationId":"get_agent","summary":"Get one voice agent: name, version, voice, publish state and response engine. Use for \"Show the configuration of one Ret","description":"Get one voice agent: name, version, voice, publish state and response engine. Use for \"Show the configuration of one Retell agent\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"agent_id":{"description":"Agent ID as returned by list_agents (agent_id).","maxLength":80,"title":"Agent Id","type":"string"},"version":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Agent version number (leave empty for the latest).","title":"Version"}},"required":["agent_id"],"title":"get_agentArguments","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_phone_numbers":{"post":{"operationId":"list_phone_numbers","summary":"List phone numbers with type, nickname, assigned inbound and outbound agents and last modification. Use for \"Which phone","description":"List phone numbers with type, nickname, assigned inbound and outbound agents and last modification. Use for \"Which phone numbers are set up in Retell and which agents answer them\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many items to return (1 to 1000).","title":"Limit"},"sort_order":{"anyOf":[{"enum":["ascending","descending"],"type":"string"},{"type":"null"}],"default":"descending","description":"Order by creation: descending (newest first) or ascending.","title":"Sort Order"},"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"}},"title":"list_phone_numbersArguments","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_voices":{"post":{"operationId":"list_voices","summary":"List the voices available to the account with provider, gender, accent, age and a preview audio URL. Use for \"Which voic","description":"List the voices available to the account with provider, gender, accent, age and a preview audio URL. Use for \"Which voices can my Retell agents use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_voicesArguments","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_retell_llms":{"post":{"operationId":"list_retell_llms","summary":"List Retell LLM response engines (the prompts and tools behind agents) with model, version, publish state and knowledge ","description":"List Retell LLM response engines (the prompts and tools behind agents) with model, version, publish state and knowledge bases. Use for \"Which Retell LLM response engines exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many items to return (1 to 1000).","title":"Limit"},"sort_order":{"anyOf":[{"enum":["ascending","descending"],"type":"string"},{"type":"null"}],"default":"descending","description":"Order by creation: descending (newest first) or ascending.","title":"Sort Order"},"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"}},"title":"list_retell_llmsArguments","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_knowledge_bases":{"post":{"operationId":"list_knowledge_bases","summary":"List knowledge bases with status, chunk sizes, sources and last refresh time. Use for \"Which Retell knowledge bases do I","description":"List knowledge bases with status, chunk sizes, sources and last refresh time. Use for \"Which Retell knowledge bases do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_knowledge_basesArguments","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}}}}