Retrieve document from a project.

Retrieve document from a project

Path Parameters

• project_id integer required

  ID of the project

• document_id integer required

  ID of the document

Query Parameters

• details string

  Possible values: [segments]

  Which details should return. Only 'segments' is supported.

  • segments: Show segments of a document

Responses

• 200
• 401
• 403
• 404
• 500

---

OK

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

{
  "text": "Document 1",
  "segments": [
    {
      "text": "Segment 1",
      "span": [
        0,
        9
      ]
    }
  ]
}

User is not authenticated. This means token is either not present or invalid

User does not have the minimal required project role "VIEWER"

The project or the document

Something is wrong with the API.

Loading...