{"openapi":"3.1.0","info":{"title":"Voiceflow (BYOK) API","version":"0.1.0","description":"Voiceflow (BYOK) lets an AI assistant read your own Voiceflow data through the Voiceflow API with a key you supply (Voiceflow personal access token). Read-only: 9 tools (list_workspaces, list_projects, get_agent, list_playbooks, list_functions, list_tools, list_api_tools, list_mcp_servers, list_variables). The BYOK key travels with each request, is used for that one call only and is never stored,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-voiceflow.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-voiceflow/docs"},"termsOfService":"https://connectorbay.com/byok-voiceflow/terms"},"servers":[{"url":"https://byok-voiceflow.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-voiceflow/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_workspaces":{"post":{"operationId":"list_workspaces","summary":"List the workspaces in the account. Use for \"Which Voiceflow workspaces do I have\".","description":"List the workspaces in the account. Use for \"Which Voiceflow workspaces do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_workspacesArguments","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_projects":{"post":{"operationId":"list_projects","summary":"List the projects (each owns one agent) in a workspace. Use for \"Which agents are in my Voiceflow workspace\".","description":"List the projects (each owns one agent) in a workspace. Use for \"Which agents are in my Voiceflow workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id from list_workspaces.","maxLength":60,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"list_projectsArguments","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 an environment's agent configuration: default model settings, global prompt (optional) and the playbooks it routes t","description":"Get an environment's agent configuration: default model settings, global prompt (optional) and the playbooks it routes to. Use for \"Show the global prompt of my Voiceflow agent in production\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Voiceflow project id (the agent's project), from list_projects.","maxLength":60,"title":"Project Id","type":"string"},"environment_alias":{"description":"Environment to read, for example 'development' or 'production'.","maxLength":60,"title":"Environment Alias","type":"string"},"include_prompt":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include the global prompt text.","title":"Include Prompt"},"include_instructions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include the instruction text of the routing playbooks.","title":"Include Instructions"}},"required":["project_id","environment_alias"],"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_playbooks":{"post":{"operationId":"list_playbooks","summary":"List the playbooks (instruction sets that drive an agent toward a goal) of an environment with model settings and timest","description":"List the playbooks (instruction sets that drive an agent toward a goal) of an environment with model settings and timestamps. Use for \"Which playbooks does my Voiceflow agent have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Voiceflow project id (the agent's project), from list_projects.","maxLength":60,"title":"Project Id","type":"string"},"environment_alias":{"description":"Environment to read, for example 'development' or 'production'.","maxLength":60,"title":"Environment Alias","type":"string"},"include_instructions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include each playbook's instruction text.","title":"Include Instructions"}},"required":["project_id","environment_alias"],"title":"list_playbooksArguments","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_functions":{"post":{"operationId":"list_functions","summary":"List the custom functions of an environment (names and timestamps; the code is not returned by this tool). Use for \"Whic","description":"List the custom functions of an environment (names and timestamps; the code is not returned by this tool). Use for \"Which custom functions exist in my Voiceflow agent\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Voiceflow project id (the agent's project), from list_projects.","maxLength":60,"title":"Project Id","type":"string"},"environment_alias":{"description":"Environment to read, for example 'development' or 'production'.","maxLength":60,"title":"Environment Alias","type":"string"}},"required":["project_id","environment_alias"],"title":"list_functionsArguments","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_tools":{"post":{"operationId":"list_tools","summary":"List the tools an environment's playbooks can call, optionally only API, MCP, function or integration tools. Use for \"Wh","description":"List the tools an environment's playbooks can call, optionally only API, MCP, function or integration tools. Use for \"Which tools can my Voiceflow agent call\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Voiceflow project id (the agent's project), from list_projects.","maxLength":60,"title":"Project Id","type":"string"},"environment_alias":{"description":"Environment to read, for example 'development' or 'production'.","maxLength":60,"title":"Environment Alias","type":"string"},"type":{"anyOf":[{"enum":["api","mcp","function","integration"],"type":"string"},{"type":"null"}],"default":null,"description":"Only tools of this kind.","title":"Type"},"playbook_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only tools attached to this playbook id.","title":"Playbook Id"}},"required":["project_id","environment_alias"],"title":"list_toolsArguments","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_api_tools":{"post":{"operationId":"list_api_tools","summary":"List saved HTTP request tools of an environment with name and HTTP method (URLs, headers and bodies are not returned). U","description":"List saved HTTP request tools of an environment with name and HTTP method (URLs, headers and bodies are not returned). Use for \"Which API tools does my Voiceflow agent use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Voiceflow project id (the agent's project), from list_projects.","maxLength":60,"title":"Project Id","type":"string"},"environment_alias":{"description":"Environment to read, for example 'development' or 'production'.","maxLength":60,"title":"Environment Alias","type":"string"}},"required":["project_id","environment_alias"],"title":"list_api_toolsArguments","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_mcp_servers":{"post":{"operationId":"list_mcp_servers","summary":"List the MCP servers registered in an environment with name and specification version (header values are redacted by Voi","description":"List the MCP servers registered in an environment with name and specification version (header values are redacted by Voiceflow). Use for \"Which MCP servers is my Voiceflow agent connected to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Voiceflow project id (the agent's project), from list_projects.","maxLength":60,"title":"Project Id","type":"string"},"environment_alias":{"description":"Environment to read, for example 'development' or 'production'.","maxLength":60,"title":"Environment Alias","type":"string"}},"required":["project_id","environment_alias"],"title":"list_mcp_serversArguments","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_variables":{"post":{"operationId":"list_variables","summary":"List the project's variables with default values and whether they are system variables. Use for \"Which variables does my","description":"List the project's variables with default values and whether they are system variables. Use for \"Which variables does my Voiceflow agent define\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Voiceflow project id (the agent's project), from list_projects.","maxLength":60,"title":"Project Id","type":"string"},"environment_alias":{"description":"Environment to read, for example 'development' or 'production'.","maxLength":60,"title":"Environment Alias","type":"string"}},"required":["project_id","environment_alias"],"title":"list_variablesArguments","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}}}}