POST
/
v4
/
knowledge-bases
/
{knowledge_base_id}
/
artifacts
/
{artifact_id}
/
chunks

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
knowledge_base_id
string
required
​
artifact_id
string
required

Body

application/json
​
chunk_position
integer
required

Position of the chunk in the artifact.

​
text
string
required

Associated text of the chunk.

​
metadata
object

Additional metadata associated with the chunk.

Response

200 - application/json
​
artifact_id
string
required

The id of the artifact

​
chunk_position
integer
required

Chunk position

​
id
string
required

The id of the chunk

​
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
​
text
string
required

The text of the chunk as stored in the database

​
created_at
string

Date and time of chunk creation

​
metadata
object

Metadata of the chunk which is stored in OpenSearch

​
status_reason
string

Status reason of the chunk. May be successful

​
user_supplied_metadata
object

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

List Chunks of Artifacts with PaginationGet Single Chunk Information and status