{"openapi":"3.1.0","info":{"title":"Intercom Internal Knowledge (BYOK) API","version":"0.1.0","description":"Intercom Internal Knowledge (BYOK) lets an AI assistant read your own Intercom Internal Knowledge data through the Intercom Internal Knowledge API with a key you supply (Intercom access token (US-hosted workspace)). Read-only: 5 tools (list_internal_articles, get_internal_article, search_internal_articles, list_external_pages, get_external_page). The BYOK key travels with each request, is used...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-intercom-internal-knowledge.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-intercom-internal-knowledge/docs"},"termsOfService":"https://connectorbay.com/byok-intercom-internal-knowledge/terms"},"servers":[{"url":"https://byok-intercom-internal-knowledge.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-intercom-internal-knowledge/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_internal_articles":{"post":{"operationId":"list_internal_articles","summary":"List the workspace's internal articles (team-only knowledge) with title, locale, owner and author ids and dates. Article","description":"List the workspace's internal articles (team-only knowledge) with title, locale, owner and author ids and dates. Article bodies are not returned. Use for \"Which internal articles does our Intercom team have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_internal_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_internal_article":{"post":{"operationId":"get_internal_article","summary":"Get one internal article by id: title, locale, owner and author ids and dates (body left out). Use for \"When was interna","description":"Get one internal article by id: title, locale, owner and author ids and dates (body left out). Use for \"When was internal article 39 last updated in Intercom\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"internal_article_id":{"description":"Numeric id of the internal article, as shown by the list.","maximum":100000000000,"minimum":1,"title":"Internal Article Id","type":"integer"}},"required":["internal_article_id"],"title":"get_internal_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}},"/v1/tools/search_internal_articles":{"post":{"operationId":"search_internal_articles","summary":"Search internal articles, optionally inside one folder. Returns the matching articles as Intercom stores them (wrapped u","description":"Search internal articles, optionally inside one folder. Returns the matching articles as Intercom stores them (wrapped under data.internal_articles); long bodies may be shortened. Use for \"Search our Intercom internal articles in folder 12\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only search inside the folder with this id (a numeric string).","title":"Folder Id"}},"title":"search_internal_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/list_external_pages":{"post":{"operationId":"list_external_pages","summary":"List external pages imported into Intercom for AI answers, with title, source link, locale, which AI features may use ea","description":"List external pages imported into Intercom for AI answers, with title, source link, locale, which AI features may use each page and when it was last ingested. Page HTML is not returned. Use for \"Which external pages feed our Intercom AI answers\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_external_pagesArguments","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_external_page":{"post":{"operationId":"get_external_page","summary":"Get one imported external page by id: title, source link, locale, AI availability flags and ingest dates (HTML left out)","description":"Get one imported external page by id: title, source link, locale, AI availability flags and ingest dates (HTML left out). Use for \"When was external page 19 last ingested by Intercom\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_id":{"description":"Id of the external page, as shown by the list (a numeric string).","maxLength":200,"title":"Page Id","type":"string"}},"required":["page_id"],"title":"get_external_pageArguments","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}}}}