Documents_list

GET 
/documents

A list of Datasphere Documents

Request

Responses

200

The request has succeeded.

application/json

Schema

Schema

data

object[]

required

Array [

id uuidrequired

Unique ID of a Document.

filename stringrequired

Name of the Document.

status DocumentStatus (string)required

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

The current Status of the Document.

tags string[]required

Document tags.

number_of_chunks integerrequired

Number of Chunks in the Document.

created_at date-timerequired

Document Creation Date.

updated_at date-timerequired

Document Update Date.

]

links

object

required

self urirequired

Link of the current page

first urirequired

Link to the first page

next urirequired

Link to the next page

Example (from schema)

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "filename": "player_list.pdf",
      "status": "submitted",
      "tags": [
        "sports",
        "football",
        "game"
      ],
      "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]

Loading...