v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB
Chunk Group

Create or Upsert Group or Groups

Create new chunk_group(s). This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail. Only 1000 chunk groups can be created at a time. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.

post/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

OR

Example request

{
  "description": "All versions and colorways of the oversized t-shirt",
  "metadata": {
    "color": "black",
    "size": "large"
  },
  "name": "Versions of Oversized T-Shirt",
  "tag_set": [
    "tshirt",
    "oversized",
    "clothing"
  ],
  "tracking_id": "SNOVERSIZEDTSHIRT",
  "upsert_by_tracking_id": false
}

Response

Returns the created chunk_group if a single chunk_group was specified or an array of all chunk_groups which were created

OR

Example response

{
  "created_at": "2021-01-01 00:00:00.000",
  "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
  "description": "All versions and colorways of the oversized t-shirt",
  "metadata": {
    "foo": "bar"
  },
  "name": "Versions of Oversized T-Shirt",
  "tag_set": [
    "tshirt",
    "oversized",
    "clothing"
  ],
  "tracking_id": "SNOVERSIZEDTSHIRT",
  "updated_at": "2021-01-01 00:00:00.000"
}