{"openapi":"3.1.0","info":{"title":"Pipecat Cloud (BYOK) API","version":"0.1.0","description":"Pipecat Cloud (BYOK) lets an AI assistant read your own Pipecat Cloud data through the Pipecat Cloud API with a key you supply (private API key). Read-only: 9 tools (list_agents, get_agent, list_agent_sessions, get_agent_session, list_builds, get_build, list_regions, get_organization_properties, list_secret_sets). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-pipecat-cloud.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-pipecat-cloud/docs"},"termsOfService":"https://connectorbay.com/byok-pipecat-cloud/terms"},"servers":[{"url":"https://byok-pipecat-cloud.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-pipecat-cloud/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_agents":{"post":{"operationId":"list_agents","summary":"List Pipecat Cloud agents with name, region, deployment ids and creation and update times, optionally for one region. Us","description":"List Pipecat Cloud agents with name, region, deployment ids and creation and update times, optionally for one region. Use for \"Which Pipecat Cloud agents do I have deployed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only agents in this region code, for example us-west.","title":"Region"}},"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 agent's readiness and health: ready and available flags, active session count, autoscaling limits, agent profile","description":"Get one agent's readiness and health: ready and available flags, active session count, autoscaling limits, agent profile, current revision phase and creation and update times. Use for \"Is my Pipecat Cloud agent ready and how many sessions are active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"agent_name":{"description":"Name of the Pipecat Cloud agent, as shown by list_agents.","maxLength":120,"title":"Agent Name","type":"string"}},"required":["agent_name"],"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_agent_sessions":{"post":{"operationId":"list_agent_sessions","summary":"List sessions of an agent with start type (cold or warm), bot start time, completion status and timestamps; filter by st","description":"List sessions of an agent with start type (cold or warm), bot start time, completion status and timestamps; filter by status, start type, deployment or time. Page size default 10. Use for \"How many cold starts did my Pipecat Cloud agent have today\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"agent_name":{"description":"Name of the Pipecat Cloud agent, as shown by list_agents.","maxLength":120,"title":"Agent Name","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Sessions to return (default 10).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Sessions to skip, for paging.","title":"Offset"},"status":{"anyOf":[{"enum":["active","ended","all"],"type":"string"},{"type":"null"}],"default":"all","description":"Only active, ended or all sessions.","title":"Status"},"start_type":{"anyOf":[{"enum":["cold","warm","all"],"type":"string"},{"type":"null"}],"default":"all","description":"Only cold starts, warm starts or all.","title":"Start Type"},"deployment_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only sessions of this deployment id.","title":"Deployment Id"},"start_time":{"anyOf":[{"maximum":4102444800,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only sessions started at or after this Unix time (seconds).","title":"Start Time"},"end_time":{"anyOf":[{"maximum":4102444800,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only sessions started at or before this Unix time (seconds).","title":"End Time"}},"required":["agent_name"],"title":"list_agent_sessionsArguments","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_session":{"post":{"operationId":"get_agent_session","summary":"Get one session: deployment, cold start flag, bot start seconds, completion status, resource usage percentiles, Daily me","description":"Get one session: deployment, cold start flag, bot start seconds, completion status, resource usage percentiles, Daily meeting ids and timestamps. Use for \"What resources did this Pipecat Cloud session use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"agent_name":{"description":"Name of the Pipecat Cloud agent, as shown by list_agents.","maxLength":120,"title":"Agent Name","type":"string"},"session_id":{"description":"Session id (UUID) from list_agent_sessions.","maxLength":60,"title":"Session Id","type":"string"}},"required":["agent_name","session_id"],"title":"get_agent_sessionArguments","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_builds":{"post":{"operationId":"list_builds","summary":"List cloud builds with status, region, Dockerfile path, error message, sizes, duration and timestamps; filter by status ","description":"List cloud builds with status, region, Dockerfile path, error message, sizes, duration and timestamps; filter by status or region. Use for \"Did my last Pipecat Cloud builds succeed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["pending","building","success","failed","timeout"],"type":"string"},{"type":"null"}],"default":null,"description":"Only builds with this status.","title":"Status"},"region":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only builds in this region code.","title":"Region"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Builds to return (1 to 100, default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Builds to skip, for paging.","title":"Offset"}},"title":"list_buildsArguments","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_build":{"post":{"operationId":"get_build","summary":"Get one build's status, region, Dockerfile path, error message, sizes, duration and timestamps. Use for \"What happened w","description":"Get one build's status, region, Dockerfile path, error message, sizes, duration and timestamps. Use for \"What happened with this Pipecat Cloud build\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"build_id":{"description":"Build id from list_builds.","maxLength":60,"title":"Build Id","type":"string"}},"required":["build_id"],"title":"get_buildArguments","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_regions":{"post":{"operationId":"list_regions","summary":"List the regions agents can be deployed to with display name, supported CPU architectures and whether the region is self","description":"List the regions agents can be deployed to with display name, supported CPU architectures and whether the region is self-hosted. Use for \"Which regions can I deploy Pipecat Cloud agents to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_regionsArguments","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_organization_properties":{"post":{"operationId":"get_organization_properties","summary":"Get organization settings such as the default region for new deployments. Use for \"What is the default deployment region","description":"Get organization settings such as the default region for new deployments. Use for \"What is the default deployment region for my Pipecat Cloud organization\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_organization_propertiesArguments","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_secret_sets":{"post":{"operationId":"list_secret_sets","summary":"List secret sets by name with type, region, readiness status and source; secret values are never returned. Use for \"Whic","description":"List secret sets by name with type, region, readiness status and source; secret values are never returned. Use for \"Which secret sets exist in my Pipecat Cloud account and are they ready\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_secret_setsArguments","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}}}}