{"openapi":"3.1.0","info":{"title":"Front Knowledge Base (BYOK) API","version":"0.1.0","description":"Front Knowledge Base (BYOK) lets an AI assistant read your own Front Knowledge Base data through the Front Knowledge Base API with a key you supply (API token). Read-only: 7 tools (list_knowledge_bases, get_knowledge_base, list_knowledge_base_categories, list_knowledge_base_articles, get_knowledge_base_category, list_category_articles, get_knowledge_base_article). 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-front-knowledge-base.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-front-knowledge-base/docs"},"termsOfService":"https://connectorbay.com/byok-front-knowledge-base/terms"},"servers":[{"url":"https://byok-front-knowledge-base.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-front-knowledge-base/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_knowledge_bases":{"post":{"operationId":"list_knowledge_bases","summary":"List knowledge bases with type (internal or external), locales and dates. Use for \"Which knowledge bases does our Front ","description":"List knowledge bases with type (internal or external), locales and dates. Use for \"Which knowledge bases does our Front workspace 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}},"/v1/tools/get_knowledge_base":{"post":{"operationId":"get_knowledge_base","summary":"Get one knowledge base by id: type, locales and dates. Use for \"Which locales does Front knowledge base knb_1 have\".","description":"Get one knowledge base by id: type, locales and dates. Use for \"Which locales does Front knowledge base knb_1 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"knowledge_base_id":{"description":"Id of the knowledge base, for example 'knb_1' (from list_knowledge_bases).","maxLength":40,"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_categories":{"post":{"operationId":"list_knowledge_base_categories","summary":"List the categories of a knowledge base with slug, hidden flag, locales and dates. Use for \"What categories does Front k","description":"List the categories of a knowledge base with slug, hidden flag, locales and dates. Use for \"What categories does Front knowledge base knb_1 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"knowledge_base_id":{"description":"Id of the knowledge base, for example 'knb_1' (from list_knowledge_bases).","maxLength":40,"title":"Knowledge Base Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 100).","title":"Limit"},"page_token":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the page_token in _pagination.next from the previous answer. Leave out for the first page.","title":"Page Token"}},"required":["knowledge_base_id"],"title":"list_knowledge_base_categoriesArguments","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 slug, locales and dates. Article text is not returned. Use for \"Which article","description":"List the articles of a knowledge base with slug, locales and dates. Article text is not returned. Use for \"Which articles are in Front knowledge base knb_1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"knowledge_base_id":{"description":"Id of the knowledge base, for example 'knb_1' (from list_knowledge_bases).","maxLength":40,"title":"Knowledge Base Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 100).","title":"Limit"},"page_token":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the page_token in _pagination.next from the previous answer. Leave out for the first page.","title":"Page Token"}},"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}},"/v1/tools/get_knowledge_base_category":{"post":{"operationId":"get_knowledge_base_category","summary":"Get one knowledge base category by id: slug, hidden flag, locales and dates. Use for \"Is Front knowledge base category k","description":"Get one knowledge base category by id: slug, hidden flag, locales and dates. Use for \"Is Front knowledge base category kbc_1 hidden\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"category_id":{"description":"Id of the category, for example 'kbc_1'.","maxLength":40,"title":"Category Id","type":"string"}},"required":["category_id"],"title":"get_knowledge_base_categoryArguments","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_category_articles":{"post":{"operationId":"list_category_articles","summary":"List the articles in one category with slug, locales and dates. Article text is not returned. Use for \"Which Front artic","description":"List the articles in one category with slug, locales and dates. Article text is not returned. Use for \"Which Front articles are in category kbc_1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"category_id":{"description":"Id of the category, for example 'kbc_1'.","maxLength":40,"title":"Category Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results to return (1 to 100).","title":"Limit"},"page_token":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the page_token in _pagination.next from the previous answer. Leave out for the first page.","title":"Page Token"}},"required":["category_id"],"title":"list_category_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}},"/v1/tools/get_knowledge_base_article":{"post":{"operationId":"get_knowledge_base_article","summary":"Get one article by id: slug, locales and dates. The article text is not returned. Use for \"When was Front article kba_1 ","description":"Get one article by id: slug, locales and dates. The article text is not returned. Use for \"When was Front article kba_1 last updated\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"article_id":{"description":"Id of the article, for example 'kba_1'.","maxLength":40,"title":"Article Id","type":"string"}},"required":["article_id"],"title":"get_knowledge_base_articleArguments","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}}}}