Describe image

Answer questions or describe an image provided in base64 or via a URL.

NodeJS

const src = await getImageAddress("http://www.cloudbrowser.ai", "img");

if (!src) return;

const ai = new AIService(cloudBrowserToken, {
    openAIConfiguration: { apiKey: openAiToken },
});

const rpai = await ai.describe({
    // base64Image: downloadImage(src), // You can send bytes instead of the image URL
    imageUrl: src,
    question: "Is the image red?",
    responseFormat: {
        properties: {
            response: { type: "boolean" },
        },
    },
});

console.log("The lowest price is:", JSON.parse(rpai.response).response);

.NET

var src = await GetImageAddress("http://www.cloudbrowser.ai","img").ConfigureAwait(false);

if (src == null) return;

using AIService ai = new(cloudBrowserToken, openAiToken);

var rpai = await ai.Describe<bool>(new() {
  //Base64Image = DownloadImage(src) //You can send bytes instead of the iamge url
  ImageUrl= src,
  Question="Is the image red?"
}).ConfigureAwait(false);

Console.WriteLine("The lowest price is: {0}", rpai);

/api/v1/ai/Describe – Answer Questions or Describe an Image

Method: POST

Parameters:

  • question: (string) – The question or task related to the image.

  • base64Image: (string) – The base64-encoded image. (optional)

  • imageUrl: (string) – The URL of the image. (optional)

  • responseFormat: (string) – The format of the response (e.g., text, json).

Notes:

  • Either base64Image or imageUrl must be provided, but not both.

Request Example:

curl -X POST https://production.cloudbrowser.ai/api/v1/ai/Describe \
-H "Content-Type: application/json" \
-d '{
  "question": "What objects are in this image?",
  "imageUrl": "https://example.com/image.jpg",
  "responseFormat": "text"
}'

Last updated