API
Ocrolus.comStart free trialRaise a request
Start typing to search…

Upload PDF to Book

post https://api.ocrolus.com/v1/book/upload

Upload a PDF file to a Book for processing.

You can upload a file to this endpoint as a multipart/form-data encoded payload. Visit our guide for more information.

📘

  • The maximum file size for upload is 200 MB.

For all Documents except bank statements, the optional form_type parameter can be used to specify the type of Document.

You can see form types we support in our forms directory. For more information, please contact your Account Executive or Customer Success Executive to discuss other options for your organization.

Body Params
file
required

The PDF file to upload.

string

The unique identifier of the Book that the uploaded Document will be saved to. Mutually exclusive with pk.

string

The PK of the Book that the uploaded Document will be saved to. Mutually exclusive with book_uuid.

string

The code identifying the type of Document that you're uploading.

string

The name of the Document that will be created from the imported file. Defaults to the name of the file if not given.

Responses

Updated 7 months ago

Did this page help you?
Language
Credentials
OAuth2
Request
Choose an example:
application/json

Updated 7 months ago

Did this page help you?