{"openapi":"3.1.0","info":{"title":"Zowie (BYOK) API","version":"0.1.0","description":"Zowie (BYOK) lets an AI assistant read your own Zowie data through the Zowie API with a key you supply (Zowie API key (EU environment)). Read-only: 10 tools (list_inbox_queues, list_agent_profiles, list_agent_groups, list_inbox_topics, list_inbox_permissions, list_mailboxes, get_mailbox, list_knowledge_bases, get_knowledge_base, list_knowledge_base_articles). The BYOK key travels with each...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-zowie.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-zowie/docs"},"termsOfService":"https://connectorbay.com/byok-zowie/terms"},"servers":[{"url":"https://byok-zowie.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-zowie/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_inbox_queues":{"post":{"operationId":"list_inbox_queues","summary":"List the support inbox queues with id, name and alias. Use for \"Which support queues exist in our Zowie inbox\".","description":"List the support inbox queues with id, name and alias. Use for \"Which support queues exist in our Zowie inbox\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_inbox_queuesArguments","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_profiles":{"post":{"operationId":"list_agent_profiles","summary":"List agent profiles (routing profiles): which queues are strict, high priority or low priority for each profile. Use for","description":"List agent profiles (routing profiles): which queues are strict, high priority or low priority for each profile. Use for \"How are our Zowie agent profiles routed across queues\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_agent_profilesArguments","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_groups":{"post":{"operationId":"list_agent_groups","summary":"List agent groups with id, name and the ids of their member users. Use for \"Which agent groups do we have in Zowie\".","description":"List agent groups with id, name and the ids of their member users. Use for \"Which agent groups do we have in Zowie\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_agent_groupsArguments","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_inbox_topics":{"post":{"operationId":"list_inbox_topics","summary":"List the conversation topics (a tree: each topic has an optional parent) used to classify conversations. Use for \"What c","description":"List the conversation topics (a tree: each topic has an optional parent) used to classify conversations. Use for \"What conversation topics does Zowie classify by\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_inbox_topicsArguments","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_inbox_permissions":{"post":{"operationId":"list_inbox_permissions","summary":"List the inbox permission names an agent role can be granted (for example QUEUES_VIEW or CONVERSATIONS_EXPORT). Use for ","description":"List the inbox permission names an agent role can be granted (for example QUEUES_VIEW or CONVERSATIONS_EXPORT). Use for \"Which permissions can be assigned in the Zowie inbox\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_inbox_permissionsArguments","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_mailboxes":{"post":{"operationId":"list_mailboxes","summary":"List the shared support mailboxes with id, name and email address, plus predefined recipient groups. Use for \"Which shar","description":"List the shared support mailboxes with id, name and email address, plus predefined recipient groups. Use for \"Which shared mailboxes are connected to Zowie\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_mailboxesArguments","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_mailbox":{"post":{"operationId":"get_mailbox","summary":"Get one shared mailbox by id: name, email address and predefined address groups. Use for \"Show Zowie mailbox mb_123\".","description":"Get one shared mailbox by id: name, email address and predefined address groups. Use for \"Show Zowie mailbox mb_123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mailbox_id":{"description":"Id of the shared mailbox (from list_mailboxes).","maxLength":64,"title":"Mailbox Id","type":"string"}},"required":["mailbox_id"],"title":"get_mailboxArguments","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 the knowledge bases with id, name, creation time (epoch milliseconds) and whether new content starts ACTIVE or INAC","description":"List the knowledge bases with id, name, creation time (epoch milliseconds) and whether new content starts ACTIVE or INACTIVE. Use for \"Which knowledge bases does Zowie use\".","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}},"/v1/tools/get_knowledge_base":{"post":{"operationId":"get_knowledge_base","summary":"Get one knowledge base by id: name, creation time and default status for new content. Use for \"Show Zowie knowledge base","description":"Get one knowledge base by id: name, creation time and default status for new content. Use for \"Show Zowie knowledge base kb_123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"knowledge_base_id":{"description":"Id of the knowledge base (from list_knowledge_bases).","maxLength":64,"title":"Knowledge Base Id","type":"string"}},"required":["knowledge_base_id"],"title":"get_knowledge_baseArguments","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_base_articles":{"post":{"operationId":"list_knowledge_base_articles","summary":"List the articles of a knowledge base with id, title, locale and created and updated times (epoch milliseconds). Article","description":"List the articles of a knowledge base with id, title, locale and created and updated times (epoch milliseconds). Article bodies are left out. Use for \"Which articles are in the Zowie knowledge base kb_123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"knowledge_base_id":{"description":"Id of the knowledge base (from list_knowledge_bases).","maxLength":64,"title":"Knowledge Base Id","type":"string"}},"required":["knowledge_base_id"],"title":"list_knowledge_base_articlesArguments","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}}}}