Sign in
Chunks

List chunks

Lists the searchable passages generated from one Datasphere document. Use it to inspect how a known source was divided for retrieval; use Search documents to find passages by semantic relevance.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: DataSphere.

Learn more about API scopes.

get/api/datasphere/documents/{documentId}/chunks

Path parameters

documentIdstring uuid required

Universal Unique Identifier.

Unique ID of the Document.

Query parameters

page_numberinteger

The page number to retrieve (0-indexed).

page_sizeinteger

Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.

page_tokenstring

Token for cursor-based pagination. Required when page_number > 0.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "tags": [
        "sports",
        "football",
        "game"
      ],
      "content": "This is the content from the original document that was chunked.",
      "created_at": "2024-05-06T12:20-12Z",
      "updated_at": "2024-05-06T12:20-12Z"
    }
  ],
  "links": {
    "self": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=0&page_size=50",
    "first": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=0&page_size=50",
    "next": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
    "prev": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=0&page_size=50&page_token=PBbff61159-faab-48b3-959a-3021a8f5beca"
  }
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.