List RenderOCR job history
Returns a list of jobs for the authenticated user, ordered by creation date descending.
Use GET /renderocr/jobs/{job_id} to retrieve full details for a specific job.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List RenderOCR job history › Responses
A list of jobs
Create a RenderOCR job
Enqueues an asynchronous OCR document conversion job.
Upload your file via POST /files first, then submit the file_id here.
Returns 202 Accepted immediately with a job_id.
Poll GET /renderocr/jobs/{job_id} to check completion.
When completed, download the converted document via GET /files/{output_file_id}/content.
Supported input formats: PDF, TIFF, JPEG, PNG, BMP. The input format is automatically detected from the uploaded file.
Note: languages accepts multiple values but currently only the first language is used.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Create a RenderOCR job › Request Body
engineEngine ID obtained from GET /renderocr/engines
file_idFile ID of the input file to process, obtained from POST /files
languagesList of language codes for OCR recognition. Currently only the first language is used.
output_formatOutput document format
Create a RenderOCR job › Responses
Job accepted
job_idfile_idInput file ID
enginestatusprogressoutput_file_idFile ID of the converted document output. Present only when status is completed. Download via GET /files/{output_file_id}/content.
Job-level error. Present only when job status is failed.
created_atupdated_atcompleted_atexpires_atGet RenderOCR job status and results
Returns the current status of a RenderOCR job.
Poll this endpoint until status is completed or failed.
Recommended polling interval: 1-5 seconds.
When status is completed, use output_file_id to download the converted document
via GET /files/{output_file_id}/content.
Results are retained for a limited period after completion (expires_at).
path Parameters
job_idThe unique identifier of the job
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get RenderOCR job status and results › Responses
Job details
job_idfile_idInput file ID
enginestatusprogressoutput_file_idFile ID of the converted document output. Present only when status is completed. Download via GET /files/{output_file_id}/content.
Job-level error. Present only when job status is failed.
created_atupdated_atcompleted_atexpires_at