Retrieve document states

Request

Provides a list of states that the specified document has passed through. If the document is still being processed, the number of returned states should not be considered final. Subsequent calls to this endpoint may return additional states as the document continues to progress through the processing pipeline.

Security

OAuth2(Required scopes: documents.read)

Path

idstringrequired

Id of the document to get states of.

curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/documents/{id}/states' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Document states.

Bodyapplication/json

Array [

statestring(DocumentState)

Enum:"done""doneAutomatically""extracted""failed""inCompletion""junk""new""processing""rejected""reviewRequired"

updatedAtstring, (date-time)

Example:"1990-12-31T15:59:60-08:00"

]

Response

[
  {
    "state": "done",
    "updatedAt": "1990-12-31T15:59:60-08:00"
  }
]