Knowledge Bases

List Resources

get

List files in the knowledge base with optional cursor pagination.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

knowledge_base_idstring · uuidRequired

Query parameters

cursorstring · nullableOptional

Optional identifier for the page that should be returned. If it is not provided, the first page will be returned.

Example: NTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAw

page_sizeinteger · min: 1 · max: 100Optional

Number of items to be returned in the page.

Default: 50

directionstring · enumOptional

Direction for pagination: 'next' to advance through pages (older items), 'prev' to go back (newer items)

Default: nextPossible values:

Responses

200

Successful Response

application/json

Other propertiesanyOptional

422

Validation Error

application/json

get/v1/knowledge-bases/{knowledge_base_id}/resources

GET /v1/knowledge-bases/{knowledge_base_id}/resources HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Create Resource

post

Upload a file directly to a knowledge base and start indexing.

This endpoint allows API users to upload files directly without needing to use presigned URLs. The file is uploaded to storage and indexing is started automatically. Returns the resource ID so callers can poll for indexing status.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

knowledge_base_idstring · uuidRequired

Body

filestring · binaryRequired

The file to upload to the knowledge base

Responses

202

Successful Response

application/json

Result of a file upload, including the resource ID for status polling.

messagestringRequired

resource_idstring · uuidRequired

422

Validation Error

application/json

post/v1/knowledge-bases/{knowledge_base_id}/resources

POST /v1/knowledge-bases/{knowledge_base_id}/resources HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "message": "text",
  "resource_id": "123e4567-e89b-12d3-a456-426614174000"
}

Get Resource By Id

get

Get one file resource by ID from the knowledge base.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

knowledge_base_idstring · uuidRequired

resource_idstring · uuidRequired

Responses

200

Successful Response

application/json

A file stored in a knowledge base.

knowledge_base_idstring · uuidRequired

created_atstring · date-timeRequired

modified_atstring · date-timeRequired

indexed_atstring · date-time · nullableOptional

resource_idstring · uuid · nullableRequired

resource_pathstring · min: 1Required

dataloader_metadataobject · Dataloader MetadataOptional

user_metadataobject · User MetadataOptional

content_hashstring · min: 1Required

content_mimestring · min: 1Required

sizeintegerRequired

statusstring · enumRequired

Processing status of a file in a knowledge base.

Possible values:

422

Validation Error

application/json

get/v1/knowledge-bases/{knowledge_base_id}/resources/{resource_id}

GET /v1/knowledge-bases/{knowledge_base_id}/resources/{resource_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "knowledge_base_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-08-07T11:28:31.744Z",
  "modified_at": "2026-08-07T11:28:31.744Z",
  "indexed_at": "2026-08-07T11:28:31.744Z",
  "resource_id": "123e4567-e89b-12d3-a456-426614174000",
  "resource_path": "text",
  "dataloader_metadata": {
    "^[^\\t\\n\\r\\f\\v]+$": null
  },
  "user_metadata": {
    "^[^\\t\\n\\r\\f\\v]+$": null
  },
  "content_hash": "text",
  "content_mime": "text",
  "size": 1,
  "status": "resource"
}

Delete Resource By Id

delete

Delete a file resource by ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

knowledge_base_idstring · uuidRequired

resource_idstring · uuidRequired

Responses

204

Successful Response

No content

422

Validation Error

application/json

delete/v1/knowledge-bases/{knowledge_base_id}/resources/{resource_id}

DELETE /v1/knowledge-bases/{knowledge_base_id}/resources/{resource_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Synchronize Knowledge Base

post

Synchronize the knowledge base.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

knowledge_base_idstring · uuidRequired

Responses

202

Successful Response

application/json

Result of a knowledge base sync or reindex request.

messagestringRequired

Human-readable description of the started task.

statusconst: acceptedOptional

Task status.

Default: accepted

422

Validation Error

application/json

post/v1/knowledge-bases/{knowledge_base_id}/sync

POST /v1/knowledge-bases/{knowledge_base_id}/sync HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text",
  "status": "accepted"
}

Get Knowledge Bases

get

List all available knowledge bases for the specified flow.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

cursorstring · nullableOptional

Optional identifier for the page that should be returned. If it is not provided, the first page will be returned.

Example: ZXhhbXBsZV9jdXJzb3I=

page_sizeinteger · min: 1 · max: 1000Optional

Number of items to be returned in the page.

Default: 50

directionstring · enumOptional

Direction for pagination: 'next' to advance through pages (older items), 'prev' to go back (newer items)

Default: nextPossible values:

Responses

200

Successful Response

application/json

A knowledge base.

knowledge_base_idstring · uuidRequired

connection_idstring · uuid · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

connection_source_idsstring[]Required

connection_provider_typestring · nullableOptional

is_emptybooleanOptionalDefault: true

total_sizeintegerOptional

Total size of all files in the knowledge base, in bytes.

Default: 0

total_filesintegerOptional

Total number of files in the knowledge base.

Default: 0

total_indexed_filesintegerOptional

Total number of successfully indexed files.

Default: 0

total_error_filesintegerOptional

Total number of files that failed indexing.

Default: 0

last_synced_atstring · date-time · nullableOptional

Timestamp when the knowledge base was last successfully synced from its source

namestring · min: 1 · max: 2048OptionalDefault: Unnamed Knowledge Base

descriptionstring · max: 2048OptionalDefault: ""

org_idstringRequired

rolestring · enum · nullableOptional

A user's role within a knowledge base.

Possible values:

org_level_rolestring · enum · nullableOptional

A user's role within a knowledge base.

Possible values:

422

Validation Error

application/json

get/v1/knowledge-bases

GET /v1/knowledge-bases HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "knowledge_base_id": "123e4567-e89b-12d3-a456-426614174000",
    "connection_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2026-08-07T11:28:31.744Z",
    "updated_at": "2026-08-07T11:28:31.744Z",
    "connection_source_ids": [
      "text"
    ],
    "website_sources": [
      {
        "source_type": "sitemap",
        "original_search_term": "text",
        "selected_resources": [
          "text"
        ]
      }
    ],
    "connection_provider_type": "text",
    "is_empty": true,
    "total_size": 0,
    "total_files": 0,
    "total_indexed_files": 0,
    "total_error_files": 0,
    "last_synced_at": "2026-08-07T11:28:31.744Z",
    "name": "Unnamed Knowledge Base",
    "description": "",
    "indexing_params": {
      "ocr": false,
      "embedding_params": {
        "embedding_model": "text",
        "api_key": "text"
      },
      "chunker_params": {
        "chunk_size": 1500,
        "chunk_overlap": 500,
        "chunker_type": "sentence"
      }
    },
    "org_id": "text",
    "role": "viewer",
    "org_level_role": "viewer",
    "user_metadata_schema": {
      "properties": {
        "^[^\\t\\n\\r\\f\\v]+$": {
          "type": "string",
          "description": "",
          "order": 0,
          "subtype": "plain"
        }
      }
    },
    "dataloader_metadata_schema": {
      "properties": {
        "^[^\\t\\n\\r\\f\\v]+$": {
          "type": "string",
          "description": "",
          "order": 0,
          "subtype": "plain"
        }
      }
    }
  }
]

Create Knowledge Base

post

Create a new knowledge base.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Payload to create a new knowledge base.

connection_idstring · uuid · nullableOptional

connection_source_idsstring[]Optional

namestring · min: 1 · max: 2048OptionalDefault: Unnamed Knowledge Base

descriptionstring · max: 2048OptionalDefault: ""

org_level_rolestring · enum · nullableOptional

A user's role within a knowledge base.

Possible values:

Responses

201

Successful Response

application/json

A knowledge base.

knowledge_base_idstring · uuidRequired

connection_idstring · uuid · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

connection_source_idsstring[]Required

connection_provider_typestring · nullableOptional

is_emptybooleanOptionalDefault: true

total_sizeintegerOptional

Total size of all files in the knowledge base, in bytes.

Default: 0

total_filesintegerOptional

Total number of files in the knowledge base.

Default: 0

total_indexed_filesintegerOptional

Total number of successfully indexed files.

Default: 0

total_error_filesintegerOptional

Total number of files that failed indexing.

Default: 0

last_synced_atstring · date-time · nullableOptional

Timestamp when the knowledge base was last successfully synced from its source

namestring · min: 1 · max: 2048OptionalDefault: Unnamed Knowledge Base

descriptionstring · max: 2048OptionalDefault: ""

org_idstringRequired

rolestring · enum · nullableOptional

A user's role within a knowledge base.

Possible values:

org_level_rolestring · enum · nullableOptional

A user's role within a knowledge base.

Possible values:

422

Validation Error

application/json

post/v1/knowledge-bases

POST /v1/knowledge-bases HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 473

{
  "connection_id": "123e4567-e89b-12d3-a456-426614174000",
  "connection_source_ids": [
    "text"
  ],
  "website_sources": [
    {
      "source_type": "sitemap",
      "original_search_term": "text",
      "selected_resources": [
        "text"
      ]
    }
  ],
  "name": "Unnamed Knowledge Base",
  "description": "",
  "indexing_params": {
    "ocr": false,
    "embedding_params": {
      "embedding_model": "openai.text-embedding-3-large",
      "api_key": "text"
    },
    "chunker_params": {
      "chunk_size": 1500,
      "chunk_overlap": 500,
      "chunker_type": "sentence"
    }
  },
  "org_level_role": "viewer"
}

{
  "knowledge_base_id": "123e4567-e89b-12d3-a456-426614174000",
  "connection_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-08-07T11:28:31.744Z",
  "updated_at": "2026-08-07T11:28:31.744Z",
  "connection_source_ids": [
    "text"
  ],
  "website_sources": [
    {
      "source_type": "sitemap",
      "original_search_term": "text",
      "selected_resources": [
        "text"
      ]
    }
  ],
  "connection_provider_type": "text",
  "is_empty": true,
  "total_size": 0,
  "total_files": 0,
  "total_indexed_files": 0,
  "total_error_files": 0,
  "last_synced_at": "2026-08-07T11:28:31.744Z",
  "name": "Unnamed Knowledge Base",
  "description": "",
  "indexing_params": {
    "ocr": false,
    "embedding_params": {
      "embedding_model": "text",
      "api_key": "text"
    },
    "chunker_params": {
      "chunk_size": 1500,
      "chunk_overlap": 500,
      "chunker_type": "sentence"
    }
  },
  "org_id": "text",
  "role": "viewer",
  "org_level_role": "viewer",
  "user_metadata_schema": {
    "properties": {
      "^[^\\t\\n\\r\\f\\v]+$": {
        "type": "string",
        "description": "",
        "order": 0,
        "subtype": "plain"
      }
    }
  },
  "dataloader_metadata_schema": {
    "properties": {
      "^[^\\t\\n\\r\\f\\v]+$": {
        "type": "string",
        "description": "",
        "order": 0,
        "subtype": "plain"
      }
    }
  }
}

Get Knowledge Base By Id

get

Get a knowledge base by its ID in the current organization.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

knowledge_base_idstring · uuidRequired

Responses

200

Successful Response

application/json

A knowledge base.

knowledge_base_idstring · uuidRequired

connection_idstring · uuid · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

connection_source_idsstring[]Required

connection_provider_typestring · nullableOptional

is_emptybooleanOptionalDefault: true

total_sizeintegerOptional

Total size of all files in the knowledge base, in bytes.

Default: 0

total_filesintegerOptional

Total number of files in the knowledge base.

Default: 0

total_indexed_filesintegerOptional

Total number of successfully indexed files.

Default: 0

total_error_filesintegerOptional

Total number of files that failed indexing.

Default: 0

last_synced_atstring · date-time · nullableOptional

Timestamp when the knowledge base was last successfully synced from its source

namestring · min: 1 · max: 2048OptionalDefault: Unnamed Knowledge Base

descriptionstring · max: 2048OptionalDefault: ""

org_idstringRequired

rolestring · enum · nullableOptional

A user's role within a knowledge base.

Possible values:

org_level_rolestring · enum · nullableOptional

A user's role within a knowledge base.

Possible values:

422

Validation Error

application/json

get/v1/knowledge-bases/{knowledge_base_id}

GET /v1/knowledge-bases/{knowledge_base_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "knowledge_base_id": "123e4567-e89b-12d3-a456-426614174000",
  "connection_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-08-07T11:28:31.744Z",
  "updated_at": "2026-08-07T11:28:31.744Z",
  "connection_source_ids": [
    "text"
  ],
  "website_sources": [
    {
      "source_type": "sitemap",
      "original_search_term": "text",
      "selected_resources": [
        "text"
      ]
    }
  ],
  "connection_provider_type": "text",
  "is_empty": true,
  "total_size": 0,
  "total_files": 0,
  "total_indexed_files": 0,
  "total_error_files": 0,
  "last_synced_at": "2026-08-07T11:28:31.744Z",
  "name": "Unnamed Knowledge Base",
  "description": "",
  "indexing_params": {
    "ocr": false,
    "embedding_params": {
      "embedding_model": "text",
      "api_key": "text"
    },
    "chunker_params": {
      "chunk_size": 1500,
      "chunk_overlap": 500,
      "chunker_type": "sentence"
    }
  },
  "org_id": "text",
  "role": "viewer",
  "org_level_role": "viewer",
  "user_metadata_schema": {
    "properties": {
      "^[^\\t\\n\\r\\f\\v]+$": {
        "type": "string",
        "description": "",
        "order": 0,
        "subtype": "plain"
      }
    }
  },
  "dataloader_metadata_schema": {
    "properties": {
      "^[^\\t\\n\\r\\f\\v]+$": {
        "type": "string",
        "description": "",
        "order": 0,
        "subtype": "plain"
      }
    }
  }
}

Delete Knowledge Base

delete

Delete a knowledge base by its ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

knowledge_base_idstring · uuidRequired

Responses

204

Successful Response

No content

422

Validation Error

application/json

delete/v1/knowledge-bases/{knowledge_base_id}

DELETE /v1/knowledge-bases/{knowledge_base_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Knowledge Base

patch

Update a knowledge base.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

knowledge_base_idstring · uuidRequired

Body

Updates to apply to an existing knowledge base.

connection_idstring · uuid · nullableOptional

connection_source_idsstring[]Optional

namestring · min: 1 · max: 2048OptionalDefault: Unnamed Knowledge Base

descriptionstring · max: 2048OptionalDefault: ""

org_level_rolestring · enum · nullableOptional

A user's role within a knowledge base.

Possible values:

Responses

200

Successful Response

application/json

A knowledge base.

knowledge_base_idstring · uuidRequired

connection_idstring · uuid · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

connection_source_idsstring[]Required

connection_provider_typestring · nullableOptional

is_emptybooleanOptionalDefault: true

total_sizeintegerOptional

Total size of all files in the knowledge base, in bytes.

Default: 0

total_filesintegerOptional

Total number of files in the knowledge base.

Default: 0

total_indexed_filesintegerOptional

Total number of successfully indexed files.

Default: 0

total_error_filesintegerOptional

Total number of files that failed indexing.

Default: 0

last_synced_atstring · date-time · nullableOptional

Timestamp when the knowledge base was last successfully synced from its source

namestring · min: 1 · max: 2048OptionalDefault: Unnamed Knowledge Base

descriptionstring · max: 2048OptionalDefault: ""

org_idstringRequired

rolestring · enum · nullableOptional

A user's role within a knowledge base.

Possible values:

org_level_rolestring · enum · nullableOptional

A user's role within a knowledge base.

Possible values:

422

Validation Error

application/json

patch/v1/knowledge-bases/{knowledge_base_id}

PATCH /v1/knowledge-bases/{knowledge_base_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 473

{
  "connection_id": "123e4567-e89b-12d3-a456-426614174000",
  "connection_source_ids": [
    "text"
  ],
  "website_sources": [
    {
      "source_type": "sitemap",
      "original_search_term": "text",
      "selected_resources": [
        "text"
      ]
    }
  ],
  "name": "Unnamed Knowledge Base",
  "description": "",
  "indexing_params": {
    "ocr": false,
    "embedding_params": {
      "embedding_model": "openai.text-embedding-3-large",
      "api_key": "text"
    },
    "chunker_params": {
      "chunk_size": 1500,
      "chunk_overlap": 500,
      "chunker_type": "sentence"
    }
  },
  "org_level_role": "viewer"
}

{
  "knowledge_base_id": "123e4567-e89b-12d3-a456-426614174000",
  "connection_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-08-07T11:28:31.744Z",
  "updated_at": "2026-08-07T11:28:31.744Z",
  "connection_source_ids": [
    "text"
  ],
  "website_sources": [
    {
      "source_type": "sitemap",
      "original_search_term": "text",
      "selected_resources": [
        "text"
      ]
    }
  ],
  "connection_provider_type": "text",
  "is_empty": true,
  "total_size": 0,
  "total_files": 0,
  "total_indexed_files": 0,
  "total_error_files": 0,
  "last_synced_at": "2026-08-07T11:28:31.744Z",
  "name": "Unnamed Knowledge Base",
  "description": "",
  "indexing_params": {
    "ocr": false,
    "embedding_params": {
      "embedding_model": "text",
      "api_key": "text"
    },
    "chunker_params": {
      "chunk_size": 1500,
      "chunk_overlap": 500,
      "chunker_type": "sentence"
    }
  },
  "org_id": "text",
  "role": "viewer",
  "org_level_role": "viewer",
  "user_metadata_schema": {
    "properties": {
      "^[^\\t\\n\\r\\f\\v]+$": {
        "type": "string",
        "description": "",
        "order": 0,
        "subtype": "plain"
      }
    }
  },
  "dataloader_metadata_schema": {
    "properties": {
      "^[^\\t\\n\\r\\f\\v]+$": {
        "type": "string",
        "description": "",
        "order": 0,
        "subtype": "plain"
      }
    }
  }
}

PreviousRun Flow NextAnalytics

Last updated 2 months ago

Was this helpful?