RenderOCR Jobs

Create and manage RenderOCR document conversion jobs

List RenderOCR job history

GET

https://gw.ldxhub.io

/renderocr/jobs

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.

List RenderOCR job history › Headers

Authorization

string · required

The 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

RenderOCRJobSummary[]

Create a RenderOCR job

POST

https://gw.ldxhub.io

/renderocr/jobs

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.

Create a RenderOCR job › Headers

Authorization

string · required

The 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

RenderOCRCreateJobRequest

engine

string · required

Engine ID obtained from GET /renderocr/engines

file_id

string · required

File ID of the input file to process, obtained from POST /files

languages

string[] · required

List of language codes for OCR recognition. Currently only the first language is used.

output_format

string · enum · required

Output document format

Enum values:

docx

xlsx

pptx

Create a RenderOCR job › Responses

Job accepted

Full job details. Returned by GET /renderocr/jobs/{job_id}.

RenderOCRJobDetail

job_id

string

file_id

string

Input file ID

engine

string

status

string · enum

Enum values:

queued

processing

completed

failed

progress

number · float

output_file_id

string

File ID of the converted document output. Present only when status is completed. Download via GET /files/{output_file_id}/content.

JobError

Job-level error. Present only when job status is failed.

created_at

string · date-time

updated_at

string · date-time

completed_at

string · date-time

expires_at

string · date-time

Usage

POST/renderocr/jobs

curl https://gw.ldxhub.io/renderocr/jobs \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "engine": "ki/ocr",
  "file_id": "ako5rgx309ehwlbqprs8s2xxnsp0y85q",
  "languages": [
    "jpn"
  ],
  "output_format": "docx"
}'

Example Request Body

{
  "engine": "ki/ocr",
  "file_id": "ako5rgx309ehwlbqprs8s2xxnsp0y85q",
  "languages": [
    "jpn"
  ],
  "output_format": "docx"
}

json

application/json

Example Responses

{
  "job_id": "akrj49467f644hncvs7cmw1bj3j1mcnk",
  "engine": "ki/ocr",
  "status": "queued",
  "progress": 0,
  "created_at": "2026-04-18T07:51:13Z",
  "updated_at": "2026-04-18T07:51:13Z",
  "expires_at": "2026-04-19T07:51:13Z"
}

json

application/json

Get RenderOCR job status and results

GET

https://gw.ldxhub.io

/renderocr/jobs/{job_id}

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).

Get RenderOCR job status and results › path Parameters

job_id

string · required

The unique identifier of the job

Get RenderOCR job status and results › Headers

Authorization

string · required

The 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

Full job details. Returned by GET /renderocr/jobs/{job_id}.

RenderOCRJobDetail

job_id

string

file_id

string

Input file ID

engine

string

status

string · enum

Enum values:

queued

processing

completed

failed

progress

number · float

output_file_id

string

File ID of the converted document output. Present only when status is completed. Download via GET /files/{output_file_id}/content.

JobError

Job-level error. Present only when job status is failed.

created_at

string · date-time

updated_at

string · date-time

completed_at

string · date-time

expires_at

string · date-time

Usage

RenderOCR Engines CastDoc Engines