List Chunks | SignalWire

using RestSharp;
var client = new RestClient("https://{your_space_name}.signalwire.com/api/datasphere/documents/documentId/chunks");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
IRestResponse response = client.Execute(request);

{
  "data": [
    {
      "id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
      "datasphere_document_id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
      "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
      "status": "completed",
      "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"
  }
}

A list of chunks for a Datasphere Document.

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.

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.

Permissions

Authentication

Path parameters

Query parameters

Response

Errors