Async Jobs

Get async OCR job

Retrieves the status and result of an async OCR job. Returns HTTP 202 if the job is still pending or processing, HTTP 200 if completed or failed.

get/v1/async/ocr/{job_id}

Request

Base URL
http://localhost:8080
Auth
- HTTP bearer
- or HTTP basic
- or API key in header x-bf-vk
- or API key in header x-api-key
TypeScript
https://skmtc.dev/getbifrost/apis/bifrost-api/docs/v1/async/ocr/:job_id/get.ts
A function with typed inputs. Its response is checked against the schema.

job_idstring required

The unique identifier of the async job

Job completed (successfully or with failure)

idstring required

Unique identifier for the async job

status'pending' | 'processing' | 'completed' | 'failed' required

The status of an async job

expires_atstring date-time

When the job result expires and will be cleaned up

created_atstring date-time required

When the job was created

completed_atstring date-time

When the job completed (successfully or with failure)

status_codeinteger

HTTP status code of the completed operation

resultunknown

No recorded changes to this operation across all 1 revision of this API.