Upload PDF to Book

Upload a PDF file to a Book for processing.


You can upload a file to this endpoint as a multipart/form-data encoded payload. To learn more, see multipart/form-data guide.

Direct document upload is not permitted for Books configured with the Classify-only processing type. Attempting to upload to such a Book returns an error indicating that direct document upload is not allowed for that Book type.

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.

📘

The maximum file size for upload is 200 MB.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
file
required

One or more PDF files to upload. Each file should be attached as its own part in the multipart/form-data body. When multiple files are uploaded together, each is processed independently and the response contains one entry per file in uploaded_docs. A partial failure, such as one duplicate file among several, does not prevent the other files from uploading successfully.

string

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

integer

A unique primary key 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

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json