PUT
/
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. If not provided, the description will not be updated.

group_id
string | null

Id of the chunk_group to update.

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. If not provided, the name will not be updated.

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

Tracking Id of the chunk_group to update.

update_chunks
boolean | null

Flag to update the chunks in the group. If true, each chunk in the group will be updated by appending the group's tags to the chunk's tags. Default is false.