API ReferenceReferenceKnowledgebases
Get a knowledgebase
Detail with its source documents and page index. Requires the knowledge:read scope.
Authorization
apiKey AuthorizationBearer <token>
An organization API key, created from a Portal's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).
In: header
Path Parameters
knowledgebaseId*string
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/knowledgebases/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "updatedAt": "2019-08-24T14:15:22Z", "counts": { "sources": 0, "pages": 0 }, "sources": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "type": "string", "status": "string", "searchable": true, "disabled": true, "url": "string", "updatedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "sizeBytes": 0, "errorMessage": "string", "createdVia": "string" } ], "pages": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "templateKey": "string", "parentPageId": "3b2da02d-bb1b-462e-a4ca-3235cd1dd440", "updatedAt": "2019-08-24T14:15:22Z", "hook": "string", "isFolder": true, "path": [ "string" ] } ]}