Retrieve a document

Retrieve a document from a group.

Path Parameters

project_id integer required
ID of the project
group_id integer required
ID of the document group
document_id integer required
ID of the document

Query Parameters

details string
Possible values: [segments, meta, tags]
Which details should return. Values might be any combination of 'segments', 'meta' and 'tags'.
- segments: Show segments of a document
- meta: Show all the additional attributes that were originally given as the document was uploaded
- tags: Show tags of a document

Responses

application/json

Schema
Example (from schema)

Schema

text string
The document text
segments object[]
list of segments
text string
The segment text
span integer[]
The interval at which the segment occurs in the original document
tags object[]
A list of tags
class string
The class's name.
label string
The label's name.

{
  "text": "Document 1",
  "segments": [
    {
      "text": "Segment 1",
      "span": [
        0,
        9
      ],
      "tags": [
        {
          "class": "Comfort",
          "label": "POS"
        }
      ]
    }
  ]
}

Retrieve a document​

Retrieve a document