Skip to content
CantoraAPI documentation
GET
/v1/organizations/{organizationId}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/knowledge-bases

List Knowledge Bases in a Tenant

Return a bounded page of Tenant-scoped Knowledge Bases and their active embedding snapshots, continuing from an opaque cursor when supplied.

Authentication

Send an API key as a Bearer token in the Authorization header.

Parameters

NameLocationRequiredDescription
organizationIdpathYes
The Organization to address.
stringA Cantora Organization identifier, prefixed with `org_`.
  • maximum length 64
  • pattern ^org_[\s\S]+$
projectIdpathYes
The Project to address.
stringA Cantora Project identifier, prefixed with `proj_`.
  • maximum length 64
  • pattern ^proj_[\s\S]+$
environmentIdpathYes
The Environment to address.
stringA Cantora Environment identifier, prefixed with `env_`.
  • maximum length 64
  • pattern ^env_[\s\S]+$
tenantIdpathYes
The Tenant to address.
stringA Cantora Tenant identifier, prefixed with `tenant_`.
  • maximum length 64
  • pattern ^tenant_[\s\S]+$
cursorqueryNo
The opaque continuation token returned by the preceding page.
string
  • maximum length 2048
  • minimum length 1
  • pattern ^[A-Za-z0-9_-]+$
limitqueryNo
The maximum number of resources to return, from 1 through 100.
string
  • pattern ^[+-]?\d*\.?\d+(?:[Ee][+-]?\d+)?$

Responses

200KnowledgeBasePage
application/json
KnowledgeBasePageEncoded
400The request path, headers, query, or JSON body did not satisfy the published schema
401Unauthorized
application/json
UnauthorizedEncoded
403Forbidden
application/json
ForbiddenEncoded

Reusable schemas

KnowledgeBasePageEncoded

object
  • unknown properties allowed false
itemsrequired
arrayThe resources in this page, in stable order.
Items
KnowledgeBaseSummaryEncoded
nextCursorrequired
The opaque continuation token for the next page, or null after the final page.
Any of
string
  • maximum length 2048
  • minimum length 1
  • pattern ^[A-Za-z0-9_-]+$
null

UnauthorizedEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Unauthorized"
reasonrequired
stringA safe explanation of why the credential was rejected.

ForbiddenEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Forbidden"
permissionrequired
stringThe permission required by the refused operation.

KnowledgeBaseSummaryEncoded

object
  • unknown properties allowed false
knowledgeBaseIdrequired
stringThe Knowledge Base identifier.
  • maximum length 64
  • pattern ^knowledge_base_[\s\S]+$
organizationIdrequired
stringThe Organization identifier.
  • maximum length 64
  • pattern ^org_[\s\S]+$
projectIdrequired
stringThe Project identifier.
  • maximum length 64
  • pattern ^proj_[\s\S]+$
environmentIdrequired
stringThe Environment identifier.
  • maximum length 64
  • pattern ^env_[\s\S]+$
tenantIdrequired
stringThe Tenant identifier.
  • maximum length 64
  • pattern ^tenant_[\s\S]+$
keyrequired
stringThe stable, human-authored Agent Definition key.
displayNamerequired
stringThe human-readable resource name.
sourceTyperequired
stringThe provider-neutral source adapter type.
dataIntegrationConnectionIdrequired
The scoped data Integration Connection identifier.
Any of
stringA Cantora Integration Connection identifier, prefixed with `data_integration_connection_`.
  • maximum length 64
  • pattern ^data_integration_connection_[\s\S]+$
null
configurationGenerationrequired
integerThe monotonically increasing Knowledge Base configuration generation.
  • greater than 0
configurationEtagrequired
stringThe strong ETag for this Knowledge Base's mutable source configuration.
  • maximum length 12
  • pattern ^"(?:[1-9][0-9]{0,9})"$
activeSnapshotrequired
The active immutable Knowledge Snapshot, or null before the first successful synchronization.
Any of
ActiveKnowledgeSnapshotEncoded
null
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time

ActiveKnowledgeSnapshotEncoded

object
  • unknown properties allowed false
knowledgeSnapshotIdrequired
stringThe immutable Knowledge Snapshot identifier.
  • maximum length 64
  • pattern ^knowledge_snapshot_[\s\S]+$
generationrequired
integerThe monotonically increasing Agent Release generation.
  • greater than 0
embeddingProviderrequired
stringThe embedding provider used to build this Snapshot.
embeddingModelrequired
stringThe embedding model used to build this Snapshot.
embeddingDimensionsrequired
integerThe number of dimensions in every embedding vector in this Snapshot.
  • greater than 0
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time