List Documents

GET 
/documents

A list of Datasphere Documents

Request

Responses

200

The request has succeeded.

application/json

Schema

Schema

data

object[]

required

Array [

iduuidrequired

Unique ID of a Document.

filenamestringrequired

Name of the Document.

Example: player_list.pdf

statusDocumentStatus (string)required

The current Status of the Document.

Possible values: [submitted, in_progress, completed, failed]

tagsstring[]required

Document tags.

Example: ["sports","football","game"]

chunking_strategyChunkingStrategy (string)required

Strategy to use when chunking the document.

Possible values: [sentence, paragraph, page, sliding]

max_sentences_per_chunkstringrequired

Max Sentences per Chunk (only used for chunking type 'sentence')

Example: 80

split_newlinesbooleanrequired

Split on Newlines (only used for chunking type 'sentence')

Example: true

overlap_sizestringrequired

Overlap Size (only used for chunking type 'sliding')

Example: 10

chunk_sizestringrequired

Chunk Size (only used for chunking type 'sliding')

Example: 50

number_of_chunksintegerrequired

Number of Chunks in the Document.

Example: 2345

created_atdate-timerequired

Document Creation Date.

Example: 2024-05-06T12:20-12Z

updated_atdate-timerequired

Document Update Date.

Example: 2024-05-06T12:20-12Z

]

links

object

required

selfurirequired

Link of the current page

Example: https://{space_name}.signalwire.com/api/data_sphere/documents?page_number=0&page_size=50

firsturirequired

Link to the first page

Example: https://{space_name}.signalwire.com/api/data_sphere/documents?page_number=0&page_size=50

nexturirequired

Link to the next page

Example: https://{space_name}.signalwire.com/api/data_sphere/documents?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca

Example (from schema)

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "filename": "player_list.pdf",
      "status": "submitted",
      "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,
      "created_at": "2024-05-06T12:20-12Z",
      "updated_at": "2024-05-06T12:20-12Z"
    }
  ],
  "links": {
    "self": "https://{space_name}.signalwire.com/api/data_sphere/documents?page_number=0&page_size=50",
    "first": "https://{space_name}.signalwire.com/api/data_sphere/documents?page_number=0&page_size=50",
    "next": "https://{space_name}.signalwire.com/api/data_sphere/documents?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
  }
}

401

Access is unauthorized.

application/json

Schema

Schema

string

Possible values: [Unauthorized]

404

The server cannot find the requested resource.

application/json

Schema

Schema

string

Possible values: [Not Found]