Skip to content
Image Onboarding
/
Endpoints
/
Register Image

Overview

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.

Register and get API Access
Download OpenAPI description
image-onboarding.json
image-onboarding.yaml
Languages
Servers

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

Endpoints

Operations

Register Image

Request

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.

Headers
api_tokenstringrequired
Bodyapplication/jsonrequired
org_image_keystring

The internal image id in your API, of the image you would like to register to Bria. If accessing your images requires authentication, you will be able to register them using org_image_key only after giving Bria the API authentication information. It is also possible to register images using an org_image_key, without any authentication data.

image_urlstring

The URL of the image you would like to register to Bria. The URL should lead to an image publicly available online. Either an org_image_key or an image_url should be provided. If both are provided, then the route will use image_url and org_image_key will be saved but not used. Images can only be registered using an image_url if they do not require authentication.

is_privatestring

The image can be included in the Bria public gallery (is_private=false) or only in the Bria gallery of your organization (is_private=true). This parameter is optional and the default value is true.

Default true
curl -i -X POST \
  https://engine.prod.bria-api.com/v1/register \
  -H 'Content-Type: application/json' \
  -H 'api_token: string' \
  -d '{
    "image_url": "https://i.natgeofe.com/n/548467d8-c5f1-4551-9f58-6817a8d2c45e/NationalGeographic_2572187_square.jpg"
  }'

Responses

Successful operation.

Bodyapplication/json
visual_idstring

Unique visual identification

Response
application/json
{
  "visual_id": "string"
}

Remove Image

Request

Description

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

Path
visual_idstringrequired
Example: b3cecc33cc31cc31
Headers
api_tokenstringrequired
curl -i -X POST \
  https://engine.prod.bria-api.com/v1/b3cecc33cc31cc31/remove_image \
  -H 'api_token: string'

Responses

Successful operation.