v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB

Chunk Group

Update Group

Update a chunk_group. One of group_id or tracking_id must be provided. If you try to change the tracking_id to one that already exists, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.

put/api/chunk_group

Headers

TR-Datasetstring uuid 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.

Request body

descriptionstring nullable

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_idstring uuid nullable

Id of the chunk_group to update.

{"stackTrail":"components:schemas:UpdateChunkGroupReqPayload:properties:metadata","oasType":"schema","type":"unknown","description":"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.","nullable":true}

namestring nullable

Name to assign to the chunk_group. Does not need to be unique. If not provided, the name will not be updated.

tag_setstring[] nullable

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_idstring nullable

Tracking Id of the chunk_group to update.

update_chunksboolean nullable

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.

Response

Confirmation that the chunkGroup was updated