Skip to content

List knowledge bases ​

Interface Description ​

Read a paginated list of knowledge bases available to the current OpenAPI key.

Endpoint ​

FieldValue
MethodGET
Path/openapi/v2/knowledge-bases
Operation IDlistKnowledgeBases
AuthenticationBearer OpenAPI key

Parameters ​

NameLocationRequiredTypeExampleDescription
limitqueryNointeger50Maximum number of records to return. The deployment can enforce a lower limit.
cursorqueryNostringcursor_123Pagination token returned by the same endpoint for reading the next page.

Request Body ​

This operation has no request body.

Request Example ​

bash
curl -X GET "https://openapi.example.com/openapi/v2/knowledge-bases?limit=50" \
  -H "Authorization: Bearer <openapi-key>"

Successful Responses ​

200 ​

Requested page of knowledge bases and the token for reading the next page.

FieldRequiredTypeDescription
itemsYesarray<KnowledgeBase>Records returned on this page.
nextCursorYesstring | nullPagination token returned by this endpoint. Reuse it only with the same endpoint and unchanged filters. If it is rejected, restart without a cursor.

Success Response Example ​

json
{
  "items": [
    {
      "knowledgeBaseId": "knowledge-base-11111111-1111-4111-8111-111111111111",
      "name": "Product Docs",
      "description": "Product documentation",
      "activeContentRevision": 1,
      "resourceRevision": 1,
      "createdAt": "2026-06-17T00:00:00.000Z",
      "updatedAt": "2026-06-17T00:00:00.000Z"
    }
  ],
  "nextCursor": null
}

Error Codes ​

The table below lists every error response documented for this operation.

HTTP StatusError CodeExplanation
401UNAUTHORIZEDThe Bearer API key is missing, malformed, unknown, revoked, or deleted.
422VALIDATION_ERRORThe request failed validation.
429RATE_LIMITEDThe request exceeded the configured rate limits.
500INTERNAL_ERRORThe API encountered an internal error.
503DATABASE_REPOSITORY_UNAVAILABLEThe data required by this operation is temporarily unavailable.

Next Steps ​