List 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.
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.
Query parameters
The page number to retrieve (0-indexed).
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
Token for cursor-based pagination. Required when page_number > 0.
Response
The request has succeeded.
Example response
{
"data": [
{
"filename": "player_list.pdf",
"tags": [
"sports",
"football",
"game"
],
"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"
}
}Changes
No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.