Sign in

v1

latestOpenAPI 3.0.3MITraw.githubusercontent.com2025-02-09165953.5 KB
Analysis

Analyze - AI Vision Tagging

The Tagging mode accepts a list of tag names along with their corresponding descriptions. If the image matches the description, which may encompass various elements, it will be appropriately tagged. This approach enables customers to align with their own brand taxonomy, offering a dynamic, flexible, and open method for image classification.

post/analyze/ai_vision_tagging

Request body

asyncboolean

Whether to perform the analysis asynchronously. If true, the response is returned immediately and analysis is done in the background. Once complete, a webhook notification will be sent to the specified URL and/or to the URLs defined in the Webhook Notifications settings of your Cloudinary Console.

notification_urlstring

The webhook URL to notify when the analysis is complete. Only relevant when async is set to true.

Example request

{
  "source": {
    "asset_id": "e12345b5c456c8901bbb0efc00c0fcf",
    "uri": "https://res.cloudinary.com/demo/image/upload/sample.jpg"
  },
  "notification_url": "https://path.to/webhook",
  "tag_definitions": [
    {
      "name": "cigarettes",
      "description": "Does the image contain a pack of cigarettes?"
    }
  ]
}

Response

Analysis succeeded

request_idstring

Example response

{
  "data": {
    "analysis": {
      "tags": [
        {
          "name": "cat"
        },
        {
          "name": "table"
        }
      ],
      "model_version": 1
    }
  },
  "limits": {
    "items": [
      {
        "type": "ai_vision",
        "used_by_request": 123,
        "remaining": 500,
        "limit": 10000,
        "reset_time": "2024-01-20T12:34:56Z"
      }
    ]
  },
  "request_id": "17c3b70c5096df0e77e838323abb7029"
}