---
title: "List documents"
method: GET
path: "/api/datasphere/documents"
tags: ["Documents"]
---

# List documents

`GET /api/datasphere/documents`

Lists the source documents added to the project's Datasphere knowledge store. Use it to inventory material available to AI applications and monitor whether it is ready for retrieval. To find passages relevant to a question rather than browse documents, use [Search documents](/docs/apis/rest/documents/search-documents).

#### 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).

## Query parameters

- `page_number` integer
- `page_size` integer
- `page_token` string

## Response `200`

The request has succeeded.

- DatasphereDocumentListResponse
  - `data` DatasphereDocument[], required — A list of documents.
    - `id` string, uuid, required — Universal Unique Identifier.
    - `filename` string, required — Name of the Document.
    - `status` 'submitted' | 'in_progress' | 'completed' | 'failed', required — The current Status of the Document.
    - `tags` string[], required — Document tags.
    - `chunking_strategy` 'sentence' | 'paragraph' | 'page' | 'sliding', required — Strategy to use when chunking the document.
    - `max_sentences_per_chunk` integer, nullable, required — Max Sentences per Chunk. Only present when chunking strategy is 'sentence', null otherwise.
    - `split_newlines` boolean, nullable, required — Split on Newlines. Only present when chunking strategy is 'sentence', null otherwise.
    - `overlap_size` integer, nullable, required — Overlap Size. Only present when chunking strategy is 'sliding', null otherwise.
    - `chunk_size` integer, nullable, required — Chunk Size. Only present when chunking strategy is 'sliding', null otherwise.
    - `number_of_chunks` integer, required — Number of Chunks in the Document.
    - `chunks_uri` string, required — URI path to the chunks for this document.
    - `created_at` string, date-time, required — Document Creation Date.
    - `updated_at` string, date-time, required — Document Update Date.
  - `links` DataspherePaginationResponse, required
    - `self` string, uri, required — Link of the current page.
    - `first` string, uri, required — Link to the first page.
    - `next` string, uri — Link to the next page. Only present when there are more results.
    - `prev` string, uri — Link to the previous page. Only present when not on the first page.

## Other responses

- `400` — The request is invalid.
- `401` — Access is unauthorized.
- `422` — The request contains invalid parameters. See errors for details.
- `500` — An internal server error occurred.

---

[API](https://skmtc.dev/signalwire/apis/signalwire-rest-api.md) · [All operations](https://skmtc.dev/signalwire/apis/signalwire-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/signalwire/signalwire-rest-api/revisions/ed4a044c7e2b/schema)