API ReferenceJobs

Submit a document for processing

Submit a document, starting a job that will process them.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
x-api-keystring

API keys will be provided by Emtelligent; contact us for key management. Keys will consist of only printable ASCII characters, and leading and trailing whitespace is insignificant.

Request

An reference to a file located in your cloud storage, a reference to your cloud object container for the result outputs, cloud credentials for the API server to retrieve your file and write into your output container, along with processing parameters. The cloud credentials are required to grant READ access from the input container, and write access to the output container. Outputs get written into your output container with below as the object key as the job is being processed. - {job_id}/status.json - {job_id}/{document_stem}/{subdoc_num}/{document_stem}.pdf - {job_id}/{document_stem}/splits.json - {job_id}/{document_stem}/{subdoc_num}/collated_ocr.json - {job_id}/{document_stem}/{subdoc_num}/ocr.json - {job_id}/{document_stem}/{subdoc_num}/ocr_geometry.json - {job_id}/{document_stem}/{subdoc_num}/best_ocr.txt - {job_id}/{document_stem}/{subdoc_num}/emtellipro_metadata.json - {job_id}/{document_stem}/{subdoc_num}/emtellipro.{emtellipro_version}.jsonl - job_id: the job identifier returned by this submit call - document_stem: the stem of the document name submitted in the input object keys - subdoc_num: the subdocument number after the input document has been split into multiple subdocuments - emtellipro_version: the version of the emtelliPro SDK that the contents of the file was generated knowing about
cloud_providerenumRequired
Allowed values:
user_credsobjectRequired
Credentials the service uses to read your input container and write your output container. These are the cloud provider's own parameter names, `aws_` prefix included, because they are passed straight through to that provider's client. Sending `access_key_id` and `secret_access_key` without the prefix is rejected with `Invalid cred format for s3`.
input_object_keysobjectRequired
input_bucketstringRequired
The name of your cloud container where the input object keys exist
output_bucketstringRequired
The name of your cloud container where the server will write outputs into
output_bucket_prefixstringOptional
Prefix the server writes this job's output under, as `<output_bucket_prefix>/<job_id>/`. Omit it and the output is written at the root of the container, under `<job_id>/`. Note that the Python SDK does not omit it for you: through 1.1.3 it sends the literal string `unused` unless you pass something, which is why output turns up under an `unused/` folder nobody asked for.

Response

Accepted, returning job information.
job_idstring

Unique ID for a Job. Use it to check Job status or cancel a job, and to find this job’s output in your container once it has succeeded: the output is written under <output_bucket_prefix>/<job_id>/, so the job ID is the whole path only when you submitted no prefix.

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error