List documents

GET

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

GET

/api/datasphere/documents

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

1 {
2   "data": [
3     {
4       "id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
5       "filename": "player_list.pdf",
6       "status": "in_progress",
7       "tags": [
8         "sports",
9         "football",
10         "game"
11       ],
12       "chunking_strategy": "sentence",
13       "max_sentences_per_chunk": 80,
14       "split_newlines": true,
15       "overlap_size": 10,
16       "chunk_size": 50,
17       "number_of_chunks": 2345,
18       "chunks_uri": "/api/rest/datasphere/documents/acaa5c49-be5e-4477-bce0-48f4b23b7720/chunks",
19       "created_at": "2024-05-06T12:20-12Z",
20       "updated_at": "2024-05-06T12:20-12Z"
21     }
22   ],
23   "links": {
24     "self": "https://{space_name}.signalwire.com/api/datasphere/documents?page_number=0&page_size=50",
25     "first": "https://{space_name}.signalwire.com/api/datasphere/documents?page_number=0&page_size=50",
26     "next": "https://{space_name}.signalwire.com/api/datasphere/documents?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
27     "prev": "https://{space_name}.signalwire.com/api/datasphere/documents?page_number=0&page_size=50&page_token=PBbff61159-faab-48b3-959a-3021a8f5beca"
28   }
29 }

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.

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

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) ```

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 documents.

linksobject

Pagination links.

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error