# Image Onboarding API Reference

Bria's Image Onboarding API allows registering images to Bria without database storage. 

It provides a simple way to obtain a visual identifier (visual_id) needed for specific Bria features like AI Search and the Image Editing Create endpoint. Images can be registered using either publicly accessible URLs or internal image keys. The API also includes functionality to remove registered images from your organization's gallery when needed.



## Servers

```
https://engine.prod.bria-api.com/v1
```

## Download OpenAPI description

[Image Onboarding API Reference](https://docs.bria.ai/_bundle/image-onboarding.yaml)

## Endpoints

### Register Image

 - [POST /register](https://docs.bria.ai/image-onboarding/endpoints/register-image.md): Description

A new visual can be registered to Bria without being uploaded to the database using the Register Route.
This route returns a visual identification to the user. This is the recommended method to onboard images to Bria, when needed.

It's the first step for consuming the Bria API for new visuals (instead of using the /upload route).

Response

  
  The visual id in the response of the Register Route must be kept by the
user in order to query image info, modify the image and use the search routes.

{ "visual_id": "9ea9a4d2d19977a7c" }

The visual_id in the response of the /upload route will be used for all other routes. Store the visual_id in your database and map it to your image identification method for easy reference

Constraints

Files should not be larger than 12MB. The status code 413 will be returned if the file exceeds its maximum size.

The Bria API currently supports only JPEG and PNG files in RGB, RGBA, or CMYK color modes. When the file is of a different type or color mode, the status code 415 will be returned.

### Remove Image

 - [POST /{visual_id}/remove_image](https://docs.bria.ai/image-onboarding/endpoints/remove-image.md): Description

With this route, you can remove an image from the gallery of your organization. The image won't be removed from Bria.