AI Search

Get Caption

Changed on

Description

The Caption Route is used to get a caption that describes the given image.

post/caption

Request

  • Base URL: https://engine.prod.bria-api.com/v1
  • URL: https://engine.prod.bria-api.com/v1/caption
  • Auth: none declared. Required headers: api_token

Headers

api_tokenstring required

Request body

image_urlstring

The URL of the input image. If both image_url and image_file are provided, image_url will be used. Accepted formats are jpeg, jpg, png, webp. Maximum file size 12MB.

filestring

The file of the input image, in base64 format. Used if image_url is not provided. Accepted formats are jpeg, jpg, png, webp. Maximum file size 12MB.

Response

Successful operation.

Example response

{
  "results": [
    {
      "caption": "woman walking on a bridge in the jungle"
    }
  ]
}

Changes