Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
AI Lake
AI Assistant
    Conversations
    Dashboard Summary
    Knowledge
      List Documents OrggetUpsert Document OrgputUpload Document OrgpostGet Document OrggetDelete Document OrgdeletePatch Document OrgpatchDownload Document OrggetSearch Documents OrggetList DocumentsgetUpsert DocumentputUpload DocumentpostGet DocumentgetDelete DocumentdeletePatch DocumentpatchDownload DocumentgetSearch Documentsget
    Knowledge Recommendations
    Memory Items
    LLM Providers
    Observability
Agents
Other
Schemas
powered by Zudoku
OpenAPI definition

Knowledge

Endpoint:/

List Documents Org

GET
/api/v1/ai/organization/knowledge/documents

List org-scoped knowledge documents.

List Documents Org › query Parameters

  • scopes
  • sizeinteger · min: 1 · max: 2000
    Default: 50
  • pageToken
  • metaInclude
  • state
  • query

List Documents Org › Responses

Successful Response

  • documentsobject[] · required
  • nextPageToken
  • totalCount
GET /api/v1/ai/organization/knowledge/documents

Upsert Document Org

PUT
/api/v1/ai/organization/knowledge/documents

Upload or replace an org-scoped knowledge document.

Upsert Document Org › Request Body

  • filestring · required
  • scopes
  • title

Upsert Document Org › Responses

Successful Response

  • filenamestring · required
  • idstring · required
  • messagestring · required
  • numChunksinteger · required
  • successboolean · required
PUT /api/v1/ai/organization/knowledge/documents

Upload Document Org

POST
/api/v1/ai/organization/knowledge/documents

Upload a new org-scoped knowledge document.

Upload Document Org › Request Body

  • filestring · required
  • scopes
  • title

Upload Document Org › Responses

Successful Response

  • filenamestring · required
  • idstring · required
  • messagestring · required
  • numChunksinteger · required
  • successboolean · required
POST /api/v1/ai/organization/knowledge/documents

Get Document Org

GET
/api/v1/ai/organization/knowledge/documents/{document_id}

Get a single org-scoped knowledge document's metadata.

Get Document Org › path Parameters

  • document_idstring · required

Get Document Org › Responses

Successful Response

  • createdAtstring · required
  • createdBystring · required
  • filenamestring · required
  • idstring · required
  • numChunksinteger · required
  • scopesstring[] · required
  • updatedAtstring · required
  • updatedBystring · required
  • isDisabled
  • title
  • workspaceId
GET /api/v1/ai/organization/knowledge/documents/{document_id}

Delete Document Org

DELETE
/api/v1/ai/organization/knowledge/documents/{document_id}

Delete an org-scoped knowledge document and all its chunks.

Delete Document Org › path Parameters

  • document_idstring · required

Delete Document Org › Responses

Successful Response

  • messagestring · required
  • successboolean · required
DELETE /api/v1/ai/organization/knowledge/documents/{document_id}

Patch Document Org

PATCH
/api/v1/ai/organization/knowledge/documents/{document_id}

Patch an org-scoped knowledge document's metadata.

Patch Document Org › path Parameters

  • document_idstring · required

Patch Document Org › Request Body

  • isDisabled
  • scopes
  • title

Patch Document Org › Responses

Successful Response

  • createdAtstring · required
  • createdBystring · required
  • filenamestring · required
  • idstring · required
  • numChunksinteger · required
  • scopesstring[] · required
  • updatedAtstring · required
  • updatedBystring · required
  • isDisabled
  • title
  • workspaceId
PATCH /api/v1/ai/organization/knowledge/documents/{document_id}

Download Document Org

GET
/api/v1/ai/organization/knowledge/documents/{document_id}/download

Download an org-scoped knowledge document's raw file.

Download Document Org › path Parameters

  • document_idstring · required

Download Document Org › Responses

The document's raw file.

No data returned
GET /api/v1/ai/organization/knowledge/documents/{document_id}/download

Search Documents Org

GET
/api/v1/ai/organization/knowledge/search

Search org-scoped knowledge documents using semantic similarity.

Search Documents Org › query Parameters

  • querystring · required
  • limitinteger · min: 1
    Default: 10
  • minScorenumber · min: 0 · max: 1
    Default: 0
  • scopes

Search Documents Org › Responses

Successful Response

  • resultsobject[] · required
  • statisticsobject · required

    Statistics about the search results.

GET /api/v1/ai/organization/knowledge/search

List Documents

GET
/api/v1/ai/workspaces/{workspace_id}/knowledge/documents

List knowledge documents accessible from the workspace (local + inherited + org-level).

List Documents › path Parameters

  • workspace_idstring · required

List Documents › query Parameters

  • scopes
  • sizeinteger · min: 1 · max: 2000
    Default: 50
  • pageToken
  • metaInclude
  • state
  • query

List Documents › Responses

Successful Response

  • documentsobject[] · required
  • nextPageToken
  • totalCount
GET /api/v1/ai/workspaces/{workspace_id}/knowledge/documents

Upsert Document

PUT
/api/v1/ai/workspaces/{workspace_id}/knowledge/documents

Upload or replace a knowledge document.

Upsert Document › path Parameters

  • workspace_idstring · required

Upsert Document › Request Body

  • filestring · required
  • scopes
  • title

Upsert Document › Responses

Successful Response

  • filenamestring · required
  • idstring · required
  • messagestring · required
  • numChunksinteger · required
  • successboolean · required
PUT /api/v1/ai/workspaces/{workspace_id}/knowledge/documents

Upload Document

POST
/api/v1/ai/workspaces/{workspace_id}/knowledge/documents

Upload a new knowledge document. Returns 409 if filename already exists.

Upload Document › path Parameters

  • workspace_idstring · required

Upload Document › Request Body

  • filestring · required
  • scopes
  • title

Upload Document › Responses

Successful Response

  • filenamestring · required
  • idstring · required
  • messagestring · required
  • numChunksinteger · required
  • successboolean · required
POST /api/v1/ai/workspaces/{workspace_id}/knowledge/documents

Get Document

GET
/api/v1/ai/workspaces/{workspace_id}/knowledge/documents/{document_id}

Get a single knowledge document's metadata. Inherited and org-level docs are visible.

Get Document › path Parameters

  • workspace_idstring · required
  • document_idstring · required

Get Document › Responses

Successful Response

  • createdAtstring · required
  • createdBystring · required
  • filenamestring · required
  • idstring · required
  • numChunksinteger · required
  • scopesstring[] · required
  • updatedAtstring · required
  • updatedBystring · required
  • isDisabled
  • title
  • workspaceId
GET /api/v1/ai/workspaces/{workspace_id}/knowledge/documents/{document_id}

Delete Document

DELETE
/api/v1/ai/workspaces/{workspace_id}/knowledge/documents/{document_id}

Delete a knowledge document and all its chunks (local docs only).

Delete Document › path Parameters

  • workspace_idstring · required
  • document_idstring · required

Delete Document › Responses

Successful Response

  • messagestring · required
  • successboolean · required
DELETE /api/v1/ai/workspaces/{workspace_id}/knowledge/documents/{document_id}

Patch Document

PATCH
/api/v1/ai/workspaces/{workspace_id}/knowledge/documents/{document_id}

Patch a knowledge document's metadata (local docs only).

Patch Document › path Parameters

  • workspace_idstring · required
  • document_idstring · required

Patch Document › Request Body

  • isDisabled
  • scopes
  • title

Patch Document › Responses

Successful Response

  • createdAtstring · required
  • createdBystring · required
  • filenamestring · required
  • idstring · required
  • numChunksinteger · required
  • scopesstring[] · required
  • updatedAtstring · required
  • updatedBystring · required
  • isDisabled
  • title
  • workspaceId
PATCH /api/v1/ai/workspaces/{workspace_id}/knowledge/documents/{document_id}

Download Document

GET
/api/v1/ai/workspaces/{workspace_id}/knowledge/documents/{document_id}/download

Download a knowledge document's raw file. Inherited and org-level docs are visible.

Download Document › path Parameters

  • workspace_idstring · required
  • document_idstring · required

Download Document › Responses

The document's raw file.

No data returned
GET /api/v1/ai/workspaces/{workspace_id}/knowledge/documents/{document_id}/download

Search Documents

GET
/api/v1/ai/workspaces/{workspace_id}/knowledge/search

Search the knowledge base using semantic similarity across the workspace ancestor chain.

Search Documents › path Parameters

  • workspace_idstring · required

Search Documents › query Parameters

  • querystring · required
  • limitinteger · min: 1
    Default: 10
  • minScorenumber · min: 0 · max: 1
    Default: 0
  • scopes

Search Documents › Responses

Successful Response

  • resultsobject[] · required
  • statisticsobject · required

    Statistics about the search results.

GET /api/v1/ai/workspaces/{workspace_id}/knowledge/search
Dashboard SummaryKnowledge Recommendations