Ocr Async Launch Job

post

https://api.edenai.run/v2/ocr/ocr_async/

Available Providers

Provider	Version	Price	Billing unit
amazon	`boto3 (v1.15.18)`	1.5 (per 1000 page)	1 page
microsoft	`rest API 4.0 (2024-02-29-preview)`	10.0 (per 1000 page)	1 page
mistral	`v1`	1.0 (per 1000 page)	1 page

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

settings

string

Defaults to [object Object]

A dictionnary or a json object to specify specific models to use for some providers.
It can be in the following format: {"google" : "google_model", "ibm": "ibm_model"...}.

providers

array of strings

required

It can be one (ex: 'amazon' or 'google') or multiple provider(s) (ex: 'amazon,microsoft,google') that the data will be redirected to in order to get the processed results.
Providers can also be invoked with specific models (ex: providers: 'amazon/model1, amazon/model2, google/model3')

providers*

fallback_providers

array of strings

length ≤ 5

Defaults to

Providers in this list will be used as fallback if the call to provider in providers parameter fails. To use this feature, you must input only one provider in the providers parameter. but you can put up to 5 fallbacks.

They will be tried in the same order they are input, and it will stop to the first provider who doesn't fail.

Doesn't work with async subfeatures.

fallback_providers

show_original_response

boolean

Defaults to false

Optional : Shows the original response of the provider.
When set to true, a new attribute original_response will appear in the response object.

webhook_receiver

uri

length ≥ 1

Webhook receiver should be a valid https URL (ex : https://your.listner.com/endpoint). After the processing is done, the webhook endpoint will receive a POST request with the result.

users_webhook_parameters

string

Json data that contains of additional parameters that will be sent back to the webhook receiver (ex: api key for security or client's data ID to link the result internally). Will only be used when webhook_receiver is set.

send_webhook_data

boolean

Defaults to true

If set to false the webhook will not contain the result data. Use if your webhook receiver has a request size limit.

show_base_64

boolean

Defaults to true

file

File to analyse in binary format to be used with content-type: multipart/form-data
Does not work with application/json !

file_url

uri | null

File URL to analyse to be used with with content-type: application/json.

file_password

string | null

If your PDF file has a password, you can pass it here!

Response

200