Perception
Get a Parse preview unit
Retained Parse jobs only. Authenticate with the same Bearer key as the job. Previews do not change parsing, cache identity, cost, retention or cancellation. Zero retention and some parsers return only the complete result. See Parse streaming.
Retained Parse jobs only. Authenticate with the same Bearer key as the job. Previews do not change parsing, cache identity, cost, retention or cancellation. Zero retention and some parsers return only the complete result. See Parse streaming.
Other errors (503) are on Errors.
Authorization
bearerAuth AuthorizationBearer <token>
Your API key, sent as Authorization: Bearer nace_sk_...
- Where: the dashboard's API Keys page. It is shown once, when you create it.
- Format:
nace_sk_followed by 43 URL-safe characters (A-Z,a-z,0-9,_and-). - Limit: an account can hold at most 3 active keys.
- Wrong or missing key: returns
401 authentication_error.
In: header
Path Parameters
idstringrequired
The Parse job_id.
Format
uuidgenerationstringrequired
Opaque value from the preview snapshot.
revisionstringrequired
Opaque value from the preview snapshot.
Response Body
application/json
curl -X GET "https://example.com/v1/documents/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08/parse-progress/parts/string/string"{ "generation": "string", "index": 0, "label": "string", "markdown": "string", "truncated": true, "ready_at": "2019-08-24T14:15:22Z"}