Documents_read

GET 
/documents/:id

Returns a Datasphere Document by ID

Request

Path Parameters

id uuidrequired

Unique ID of a Document.

Responses

200

The request has succeeded.

application/json

Schema

Schema

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.

Example (from schema)

{
  "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"
}

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