Upload Image to Book

Upload image files to a Book.


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

With the capability to classify images, you can upload a single image using this endpoint. To upload multiple images to the same Book, call this endpoint once for each image, and then call the Finalize image group endpoint to complete the image group.

We support uploads of the images in the JPEG, PNG, BMP, and TIFF (Single-image files only) formats.

📘

The term image group refers to a collection of images that may consist of one or more images.

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

The image file that you want to upload. The maximum file size is 200 MB.

string

Universally unique identifier (uuid) of the Book to which the uploaded images will be saved to. Mutually exlusive with pk.

string

Unique primary key (PK) of the Book to which the uploaded images will be saved to. Mutually exlusive with book_uuid.

boolean

Indicates if the response will include the PK of the uploaded image.

Responses

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