List chunks

GET

https://{your_space_name}.signalwire.com/api/datasphere/documents/:documentId/chunks

GET

/api/datasphere/documents/:documentId/chunks

$ curl https://{your_space_name}.signalwire.com/api/datasphere/documents/documentId/chunks \
>      -u "<project_id>:<api_token>"

1 {
2   "data": [
3     {
4       "id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
5       "datasphere_document_id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
6       "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
7       "status": "completed",
8       "tags": [
9         "sports",
10         "football",
11         "game"
12       ],
13       "content": "This is the content from the original document that was chunked.",
14       "created_at": "2024-05-06T12:20-12Z",
15       "updated_at": "2024-05-06T12:20-12Z"
16     }
17   ],
18   "links": {
19     "self": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=0&page_size=50",
20     "first": "https://{space_name}.signalwire.com/api/datasphere/documents/{document_id}/chunks?page_number=0&page_size=50",
21     "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",
22     "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"
23   }
24 }

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.

Lists the searchable passages generated from one Datasphere document. Use it to inspect how a known source was divided for retrieval; use [Search documents](/docs/apis/rest/documents/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](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

documentIdstringRequiredformat: "uuid"

Unique ID of the Document.

Query parameters

page_numberintegerOptional>=0Defaults to 0

The page number to retrieve (0-indexed).

page_sizeintegerOptional1-1000Defaults to 50

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

page_tokenstringOptional

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

Response

The request has succeeded.

datalist of objects

A list of chunks.

linksobject

Pagination links.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error