Skip to navigation
Prep API Reference

Process documents from a cloud storage bucket

In API version 1, the output keys contain the stem of the document's file name. In version 2, they do not.

Authentication

AuthorizationBearer
Your API key

Path parameters

api_versionenumRequired
Allowed values:

Request

This endpoint expects an object.
cloud_providerenumRequired
Allowed values:
user_credsobject or anyRequired

Credentials for the buckets. Their shape depends on cloud_provider.

input_bucketstringRequired
Must match the server's allowed input buckets
input_object_keysobjectRequired

Object keys in input_bucket. When operation has ep but not split, splits_json and params.subdoc_num_string are required; when it also has no ocr, best_ocr is required too.

output_bucketstringRequired
Must match the server's allowed output buckets
output_bucket_prefixstringOptionalDefaults to
operationenumOptionalDefaults to split-ocr-ep
paramsobject or nullOptional
Processing options. A server can reject some of them.

Response

OK
job_idstring

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
500
Internal Server Error
503
Service Unavailable Error