Documents

API for knowledge base documents

List documents

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

GET/workspaces/{workspaceId}/content/documents

Path parameters

workspaceId*string

Query parameters

Response

200404422429

OK

Body

application/json

resultsarray of Touchpoints_Document (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/content/documents', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404422429

{
  "results": [
    {
      "authors": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        }
      ],
      "body": "text",
      "createdAt": "2024-09-07T23:32:53.676Z",
      "folderId": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "path": "text",
      "slug": "text",
      "status": "draft",
      "tags": [
        "text"
      ],
      "title": "text",
      "updatedAt": "2024-09-07T23:32:53.676Z"
    }
  ],
  "nextPageToken": "text"
}

Create document

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

POST/workspaces/{workspaceId}/content/documents

Path parameters

workspaceId*string

Query parameters

Body

application/json

body*string

Contents of the document, can be markdown or plain text

folderIdnullable string (uuid)

ID of the folder to store the document

folderPathnullable string

Path of the folder to store the document

status*enum

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

draftactiveinactive

tagsarray of string

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

title*string

Title of the document

Response

201404409422429

Created

Body

application/json

authors*nullable array of Touchpoints_DocumentAuthor (object)

body*string

createdAt*string (date-time)

folderId*string (uuid)

id*string (uuid)

path*string

slug*string

status*enum

draftactiveinactive

tags*array of string

title*string

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/content/documents', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "body": "text",
      "status": "draft"
    }),
});
const data = await response.json();

Response

201404409422429

{
  "authors": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "body": "text",
  "createdAt": "2024-09-07T23:32:53.676Z",
  "folderId": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "status": "draft",
  "tags": [
    "text"
  ],
  "title": "text",
  "updatedAt": "2024-09-07T23:32:53.676Z"
}

Get document

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

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

Path parameters

workspaceId*string

contentPath*string

Response

200404422429

OK

Body

application/json

authors*nullable array of Touchpoints_DocumentAuthor (object)

body*string

createdAt*string (date-time)

folderId*string (uuid)

id*string (uuid)

path*string

slug*string

status*enum

draftactiveinactive

tags*array of string

title*string

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/content/documents/{contentPath}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404422429

{
  "authors": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "body": "text",
  "createdAt": "2024-09-07T23:32:53.676Z",
  "folderId": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "status": "draft",
  "tags": [
    "text"
  ],
  "title": "text",
  "updatedAt": "2024-09-07T23:32:53.676Z"
}

Delete documents

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

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

Path parameters

workspaceId*string

contentPath*string

Response

204404422429

Deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/content/documents/{contentPath}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

404422429

{
  "code": "text",
  "message": "text"
}

Update Document

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

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

Path parameters

workspaceId*string

contentPath*string

Query parameters

Body

application/json

bodystring

Contents of the document, can be markdown or plain text

folderIdnullable string (uuid)

ID of the folder to store the document

folderPathnullable string

Path of the folder to store the document

statusenum

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

draftactiveinactive

tagsarray of string

titlestring

Title of the document

Response

200404409422429

Updated

Body

application/json

authors*nullable array of Touchpoints_DocumentAuthor (object)

body*string

createdAt*string (date-time)

folderId*string (uuid)

id*string (uuid)

path*string

slug*string

status*enum

draftactiveinactive

tags*array of string

title*string

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/content/documents/{contentPath}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404409422429

{
  "authors": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "body": "text",
  "createdAt": "2024-09-07T23:32:53.676Z",
  "folderId": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "status": "draft",
  "tags": [
    "text"
  ],
  "title": "text",
  "updatedAt": "2024-09-07T23:32:53.676Z"
}