Get Document

GET 
/api/documents/:id

Get Document

Request

Path Parameters

id Idrequired

The document ID.

Responses

200

Successful Response

application/json

Schema

Schema

id

object

anyOf

MOD1

integer

collection Collectionrequired

extracted_text

object

anyOf

MOD1

string

url

object

anyOf

MOD1

string

ingest_state

object

anyOf

IngestState

string

ingest_error

object

anyOf

MOD1

string

Example (from schema)

{
  "id": 0,
  "collection": "string",
  "extracted_text": "string",
  "url": "string",
  "ingest_state": "pending",
  "ingest_error": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Messagerequired

type Error Typerequired

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...