Skip to navigation
REST ClientDatasphere

list

View as MarkdownOpen in Claude

List documents in the project.

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

datalist of objectsRequired
A list of documents.

Response Example

Response
{
  "data": [
    {
      "id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
      "filename": "player_list.pdf",
      "status": "in_progress",
      "tags": [
        "sports",
        "football",
        "game"
      ],
      "chunking_strategy": "sentence",
      "max_sentences_per_chunk": 80,
      "split_newlines": true,
      "overlap_size": 10,
      "chunk_size": 50,
      "number_of_chunks": 2345,
      "chunks_uri": "/api/rest/datasphere/documents/acaa5c49-be5e-4477-bce0-48f4b23b7720/chunks",
      "created_at": "2024-05-06T12:20-12Z",
      "updated_at": "2024-05-06T12:20-12Z"
    }
  ],
  "links": {
    "self": "https://{space_name}.signalwire.com/api/datasphere/documents?page_number=0&page_size=50",
    "first": "https://{space_name}.signalwire.com/api/datasphere/documents?page_number=0&page_size=50",
    "next": "https://{space_name}.signalwire.com/api/datasphere/documents?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
    "prev": "https://{space_name}.signalwire.com/api/datasphere/documents?page_number=0&page_size=50&page_token=PBbff61159-faab-48b3-959a-3021a8f5beca"
  }
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
const result = await client.datasphere.documents.list();
for (const doc of result.data ?? []) {
    console.log(doc.name, doc.id);
}