POST
/
api
/
chunk_group

Authorizations

Authorization
string
headerrequired

Headers

TR-Dataset
string
required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Body

application/json
description
string | null

Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for.

metadata
any | null

Optional metadata to assign to the chunk_group. This is a JSON object that can store any additional information you want to associate with the chunks inside of the chunk_group.

name
string | null

Name to assign to the chunk_group. Does not need to be unique.

tag_set
string[] | null

Optional tags to assign to the chunk_group. This is a list of strings that can be used to categorize the chunks inside the chunk_group.

tracking_id
string | null

Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group.

upsert_by_tracking_id
boolean | null

Upsert when a chunk_group with the same tracking_id exists. By default this is false, and the request will fail if a chunk_group with the same tracking_id exists. If this is true, the chunk_group will be updated if a chunk_group with the same tracking_id exists.

Response

200 - application/json
created_at
string
required
dataset_id
string
required
description
string
required
id
string
required
name
string
required
updated_at
string
required
metadata
any | null
tag_set
(string | null)[] | null
tracking_id
string | null