v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB
Chunk

Create or Upsert Chunk or Chunks

Create new chunk(s). If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.

post/api/chunk

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

{
  "chunk_html": "<p>Some HTML content</p>",
  "fulltext_boost": {
    "boost_factor": 5,
    "phrase": "foo"
  },
  "group_ids": [
    "d290f1ee-6c54-4b01-90e6-d701748f0851"
  ],
  "group_tracking_ids": [
    "group_tracking_id"
  ],
  "image_urls": [
    "https://example.com/red",
    "https://example.com/blue"
  ],
  "link": "https://example.com",
  "location": {
    "lat": -34,
    "lon": 151
  },
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "semantic_boost": {
    "distance_factor": 0.5,
    "phrase": "flagship"
  },
  "tag_set": [
    "tag1",
    "tag2"
  ],
  "time_stamp": "2021-01-01 00:00:00.000",
  "tracking_id": "tracking_id"
}

Response

JSON response payload containing the created chunk

OR

Example response

{
  "chunk_metadata": [
    {
      "content": "Some content",
      "link": "https://example.com",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "tag_set": [
        "tag1",
        "tag2"
      ],
      "time_stamp": "2021-01-01 00:00:00.000",
      "tracking_id": "tracking_id",
      "weight": 0.5
    }
  ],
  "pos_in_queue": 1
}