VocalDocscontracts 1.65.0

List Knowledge bases

GET /v1/knowledge-bases

PropertyValue
Operationlist_knowledge_bases
GroupKnowledge bases
Scopeknowledge:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read; a Knowledge base and its versions carry no content.
Released in1.53.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Lists the Knowledge bases of the Organization, newest first (1.53.0); archived ones only with archived=true.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the knowledge:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/knowledge-bases" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
archivedqueryone of "true", "false"notrue lists only archived Knowledge bases; false, the default, only the others.

Responses

StatusContent typeShapeError codes
200application/jsonKnowledgeBaseList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is KnowledgeBaseList.

FieldTypeRequiredDescription
dataarray of KnowledgeBaseyesThe Knowledge bases of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes