API Basics
Samples
Metadata & Tags
Analyses
- The Analysis Resource
- GETRetrieve All Analyses
- GETRetrieve An Analysis
- GETRetrieve Analysis Results
- GETRetrieve Analysis Files
- GETRetrieve Analysis Output File Details
- The Classification Resource
- GETRetrieve All Classifications
- GETRetrieve A Classification
- GETRetrieve Classification Results
- GETRead-Level Results
- The Panel Resource
- GETRetrieve All Panels
- GETRetrieve A Panel
- GETPanel Results
- The Alignment Resource
- GETRetrieve All Alignments
- GETRetrieve An Alignment
Documents
Documents
Retrieve A Document
Documents
Retrieve A Document
GET
/
api
/
v1
/
documents
/
{id}
{
"$uri": "/api/v1/documents/a1b2c3d4e5f67890",
"created_at": "2023-11-07T05:31:56Z",
"downloaders": [],
"filename": "<string>",
"size": 123,
"uploader": {
"$ref": "/api/v1/users/a1b2c3d4e5f67890"
}
}
GET a single Document by its ID.
Path Parameters
Response
200 - application/json
Successful operation
The response is of type object
.
{
"$uri": "/api/v1/documents/a1b2c3d4e5f67890",
"created_at": "2023-11-07T05:31:56Z",
"downloaders": [],
"filename": "<string>",
"size": 123,
"uploader": {
"$ref": "/api/v1/users/a1b2c3d4e5f67890"
}
}