View documents

Get list of documents

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

spaceIndexstringOptional

Space index to which docs belong

Responses

200

Get all documents for space (based on routine it belongs)

application/json

get

/api/documents

HTTPcURLJavaScriptPython

GET /api/documents HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Get all documents for space (based on routine it belongs)

{
  "documents": [
    "text"
  ]
}

Get single document

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

documentIndexstringRequired

Responses

200

Get single document

application/json

get

/api/documents/{documentIndex}

HTTPcURLJavaScriptPython

GET /api/documents/{documentIndex} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Get single document

{
  "name": "text",
  "documentIndex": "text",
  "routineIndex": {},
  "description": "text",
  "pages": [
    "text"
  ],
  "zones": [
    "text"
  ]
}