Skip to main content
GET
Python

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Path Parameters

knowledge_base_id
string
required
artifact_id
string
required
chunk_id
string
required

Response

Successful Response

id
string
required

The id of the chunk

text
string
required

The text of the chunk as stored in the database

artifact_id
string
required

The id of the artifact

chunk_position
integer
required

Chunk position

status
enum<string>
required

Status of the chunk. If Failed or Pending, its possible that the chunk does not reflect in OpenSearch

Available options:
Pending,
Completed,
Failed
metadata
Metadata · object

Metadata of the chunk which is stored in OpenSearch

user_supplied_metadata
User Supplied Metadata · object

Metadata of the chunk which is stored in the database only provided via custom chunking.

status_reason
string

Status reason of the chunk. May be successful

created_at
string<date-time>

Date and time of chunk creation