Documents

API for knowledge base documents

Was this helpful?

List documents

List a document on a given workspace and folder for a knowledge base.

get

/workspaces/{workspaceId}/content/documents

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the project of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

authorIdsstring · uuid[] | nullable

Filter documents that were edited by at least one user from the list

tagsstring[] | nullable

Filter documents that have at least one of the provided tags

folderPathsstring[] | nullable

Paths of the folder. This can be used to narrow search to a specific folder

orderBystring

Special ordering setting for the result documents

Example: createdAt:asc

statusstring · enum | nullable

Filter documents based on status

Options: draft, active, inactive

titlestring | nullable

Filter documents based on title

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/content/documents'

200

404

422

429

{
  "results": [
    {
      "body": "text",
      "createdAt": "2025-02-21T18:05:30.441Z",
      "folderId": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "path": "text",
      "slug": "text",
      "title": "text",
      "updatedAt": "2025-02-21T18:05:30.441Z",
      "status": "draft",
      "authors": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        }
      ],
      "tags": [
        "text"
      ]
    }
  ],
  "nextPageToken": "text"
}

Create document

Create a document on a given workspace and folder for a knowledge base.

post

/workspaces/{workspaceId}/content/documents

Path parameters

workspaceIdstringrequired

Query parameters

asyncEmbeddingboolean

Indicates if embedding should be done asynchronously

Body

bodystringrequired

Contents of the document, can be markdown or plain text

folderIdstring · uuid | nullable

ID of the folder to store the document

folderPathstring | nullable

Path of the folder to store the document

titlestringrequired

Title of the document

statusstring · enumrequired

Status of the document. If you want your document to be visible and used by other systems, make it 'active'

Options: draft, active, inactive

tagsstring[]

Tags can be used to label the content and used in search

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/content/documents' \
  --header 'Content-Type: application/json' \
  --data '{"body":"text","title":"text","status":"draft","tags":[null]}'

201

404

409

422

429

{
  "body": "text",
  "createdAt": "2025-02-21T18:05:30.441Z",
  "folderId": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "title": "text",
  "updatedAt": "2025-02-21T18:05:30.441Z",
  "status": "draft",
  "authors": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "tags": [
    "text"
  ]
}

Created

Get document

Get a document on a given workspace an folder for a knowledge base.

get

/workspaces/{workspaceId}/content/documents/{contentPath}

Path parameters

workspaceIdstringrequired

contentPathstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/content/documents/{contentPath}'

200

404

422

429

{
  "body": "text",
  "createdAt": "2025-02-21T18:05:30.441Z",
  "folderId": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "title": "text",
  "updatedAt": "2025-02-21T18:05:30.441Z",
  "status": "draft",
  "authors": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "tags": [
    "text"
  ]
}

Delete documents

Delete a folder on a given workspace and folder for a knowledge base.

delete

/workspaces/{workspaceId}/content/documents/{contentPath}

Path parameters

workspaceIdstringrequired

contentPathstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/content/documents/{contentPath}'

204

404

422

429

No body

Deleted

Update Document

Update a document on a given workspace for a knowledge base.

patch

/workspaces/{workspaceId}/content/documents/{contentPath}

Path parameters

workspaceIdstringrequired

contentPathstringrequired

Query parameters

asyncEmbeddingboolean

Indicates if embedding should be done asynchronously

Body

bodystring

Contents of the document, can be markdown or plain text

folderIdstring · uuid | nullable

ID of the folder to store the document

folderPathstring | nullable

Path of the folder to store the document

titlestring

Title of the document

statusstring · enum

Status of the document. If you want your document to be visible and used by other systems, make it 'active'

Options: draft, active, inactive

tagsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/content/documents/{contentPath}' \
  --header 'Content-Type: application/json' \
  --data '{"status":"draft","tags":[null]}'

200

404

409

422

429

{
  "body": "text",
  "createdAt": "2025-02-21T18:05:30.441Z",
  "folderId": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "title": "text",
  "updatedAt": "2025-02-21T18:05:30.441Z",
  "status": "draft",
  "authors": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "tags": [
    "text"
  ]
}

Updated