---
title: "Upload Image to Book"
method: POST
path: "/v1/book/upload/image"
tags: ["File Uploads"]
---

# Upload Image to Book

`POST /v1/book/upload/image`

Upload image files to a <<glossary:Book>>.

--- 

You can upload a file to this endpoint as a `multipart/form-data` encoded payload. Visit [our guide](https://docs.ocrolus.com/reference/multipartform-data-payloads) 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 <<glossary:Book>>, call this endpoint once for each image, and then call the [Finalize image group](https://docs.ocrolus.com/ocrolus-api/reference/mark-image-group-complete) 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.

## Response `200`

200

- union
  - object
    - `status` integer — A numerical code that indicates the status of the request.
    - `response` object — An object received from the server that potentially contains data.
      - `image_group_pk` integer — Unique primary key (PK) of the <<glossary:image group>>.
    - `message` string — A textual description that indicates details about this response's status.
  - object
    - `status` integer — A numerical code that indicates the status of the request.
    - `response` object — An object received from the server that potentially contains data.
      - `status` integer — A numerical code that indicates the status of the request.
      - `message` string — A textual description that indicates details about this response's status.
      - `original_existing_groups_and_image_pks` object[] — An array of details associated with the image group.
        - `existing_image_group_pk` integer — Unique primary key (PK) of the existing <<glossary:image group>>.
        - `existing_image_pk` integer — Name of the image group.
        - `existing_image_uuid` integer — Unique unique identifer of the existing <<glossary:image group>>.
      - `image_group_pk` integer — Unique primary key (PK) of the image group.
    - `message` string — A textual description that indicates details about this response's status.
  - object
    - `status` integer — A numerical code that indicates the status of the request.
    - `response` object — An object received from the server that potentially contains data.
      - `status` integer — A numerical code that indicates the status of the request.
      - `message` string — A textual description that indicates details about this response's status.
      - `original_existing_groups_and_image_pks` object[] — An array of details associated with the image group.
        - `existing_image_group_pk` integer — Unique primary key (PK) of the existing <<glossary:image group>>.
        - `existing_image_pk` integer — Name of the existing image group.
        - `existing_image_uuid` integer — Unique unique identifer of the existing <<glossary:image group>>.
      - `image_group_pk` integer — Unique primary key (PK) of the image group.
    - `message` string — A textual description that indicates details about this response's status.

## Other responses

- `400` — Client Errors

---

[API](https://skmtc.net/ocrolus/apis/user-management.md) · [All operations](https://skmtc.net/ocrolus/apis/user-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ocrolus/user-management/versions/3571ef602d13/schema)