KnowledgeBaseId

The id of a Knowledge base: kb_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.

A value of type string.

Used by

The operations whose parameters, request body or responses name this shape directly.

• GET /v1/knowledge-bases/{knowledge_base_id}
• PATCH /v1/knowledge-bases/{knowledge_base_id}
• DELETE /v1/knowledge-bases/{knowledge_base_id}
• GET /v1/knowledge-bases/{knowledge_base_id}/documents
• POST /v1/knowledge-bases/{knowledge_base_id}/documents
• GET /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}
• DELETE /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}
• GET /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}/content
• POST /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}/purge
• POST /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}/review
• GET /v1/knowledge-bases/{knowledge_base_id}/eval-queries
• POST /v1/knowledge-bases/{knowledge_base_id}/eval-queries
• GET /v1/knowledge-bases/{knowledge_base_id}/eval-queries/{eval_query_id}
• PATCH /v1/knowledge-bases/{knowledge_base_id}/eval-queries/{eval_query_id}
• DELETE /v1/knowledge-bases/{knowledge_base_id}/eval-queries/{eval_query_id}
• POST /v1/knowledge-bases/{knowledge_base_id}/evaluations
• GET /v1/knowledge-bases/{knowledge_base_id}/evaluations/{evaluation_id}
• GET /v1/knowledge-bases/{knowledge_base_id}/ingestion-runs
• GET /v1/knowledge-bases/{knowledge_base_id}/ingestion-runs/{run_id}
• POST /v1/knowledge-bases/{knowledge_base_id}/query
• GET /v1/knowledge-bases/{knowledge_base_id}/sources
• POST /v1/knowledge-bases/{knowledge_base_id}/sources
• GET /v1/knowledge-bases/{knowledge_base_id}/sources/{source_id}
• PATCH /v1/knowledge-bases/{knowledge_base_id}/sources/{source_id}
• DELETE /v1/knowledge-bases/{knowledge_base_id}/sources/{source_id}
• POST /v1/knowledge-bases/{knowledge_base_id}/sources/{source_id}/sync
• GET /v1/knowledge-bases/{knowledge_base_id}/versions
• POST /v1/knowledge-bases/{knowledge_base_id}/versions
• GET /v1/knowledge-bases/{knowledge_base_id}/versions/{version}
• POST /v1/knowledge-bases/{knowledge_base_id}/versions/{version}/activate
• POST /v1/knowledge-bases/{knowledge_base_id}/versions/{version}/retire