---
title: "POST /analyze"
method: POST
path: "/analyze"
---

# POST /analyze

`POST /analyze`

This operation extracts a rich set of visual features based on the image content.
Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response.
A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

## Query parameters

- `visualFeatures` string[]
- `details` string[]
- `language` 'en' | 'es' | 'ja' | 'pt' | 'zh'
- `descriptionExclude` string[]

## Request body

- ImageUrl
  - `url` string, required — Publicly reachable URL of an image.

## Response `200`

The response include the extracted features in JSON format. Here is the definitions for enumeration types:
 ClipartType
 Non - clipart = 0, ambiguous = 1, normal - clipart = 2, good - clipart = 3. LineDrawingTypeNon - LineDrawing = 0, LineDrawing = 1.

- ImageAnalysis, nullable — Result of AnalyzeImage operation.
  - `categories` Category[], nullable — An array indicating identified categories.
    - `name` string, nullable — Name of the category.
    - `score` number, double — Scoring of the category.
    - `detail` CategoryDetail, nullable — An object describing additional category details.
      - `celebrities` CelebritiesModel[], nullable — An array of celebrities if any identified.
        - `name` string, nullable — Name of the celebrity.
        - `confidence` number, double — Confidence level for the celebrity recognition as a value ranging from 0 to 1.
        - `faceRectangle` FaceRectangle, nullable — An object describing face rectangle.
          - `left` integer — X-coordinate of the top left point of the face, in pixels.
          - `top` integer — Y-coordinate of the top left point of the face, in pixels.
          - `width` integer — Width measured from the top-left point of the face, in pixels.
          - `height` integer — Height measured from the top-left point of the face, in pixels.
      - `landmarks` LandmarksModel[], nullable — An array of landmarks if any identified.
        - `name` string, nullable — Name of the landmark.
        - `confidence` number, double — Confidence level for the landmark recognition as a value ranging from 0 to 1.
  - `adult` AdultInfo, nullable — An object describing whether the image contains adult-oriented content and/or is racy.
    - `isAdultContent` boolean — A value indicating if the image contains adult-oriented content.
    - `isRacyContent` boolean — A value indicating if the image is racy.
    - `isGoryContent` boolean — A value indicating if the image is gory.
    - `adultScore` number, double — Score from 0 to 1 that indicates how much the content is considered adult-oriented within the image.
    - `racyScore` number, double — Score from 0 to 1 that indicates how suggestive is the image.
    - `goreScore` number, double — Score from 0 to 1 that indicates how gory is the image.
  - `color` ColorInfo, nullable — An object providing additional metadata describing color attributes.
    - `dominantColorForeground` string, nullable — Possible dominant foreground color.
    - `dominantColorBackground` string, nullable — Possible dominant background color.
    - `dominantColors` string[], nullable — An array of possible dominant colors.
    - `accentColor` string, nullable — Possible accent color.
    - `isBWImg` boolean — A value indicating if the image is black and white.
  - `imageType` ImageType, nullable — An object providing possible image types and matching confidence levels.
    - `clipArtType` integer — Confidence level that the image is a clip art.
    - `lineDrawingType` integer — Confidence level that the image is a line drawing.
  - `tags` ImageTag[], nullable — A list of tags with confidence level.
    - `name` string, nullable — Name of the entity.
    - `confidence` number, double — The level of confidence that the entity was observed.
    - `hint` string, nullable — Optional hint/details for this tag.
  - `description` ImageDescriptionDetails, nullable — A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.
    - `tags` string[], nullable — A collection of image tags.
    - `captions` ImageCaption[], nullable — A list of captions, sorted by confidence level.
      - `text` string, nullable — The text of the caption.
      - `confidence` number, double — The level of confidence the service has in the caption.
  - `faces` FaceDescription[], nullable — An array of possible faces within the image.
    - `age` integer — Possible age of the face.
    - `gender` 'Male' | 'Female', nullable — Possible gender of the face.
    - `faceRectangle` FaceRectangle, nullable — An object describing face rectangle.
      - `left` integer — X-coordinate of the top left point of the face, in pixels.
      - `top` integer — Y-coordinate of the top left point of the face, in pixels.
      - `width` integer — Width measured from the top-left point of the face, in pixels.
      - `height` integer — Height measured from the top-left point of the face, in pixels.
  - `objects` DetectedObject[], nullable — Array of objects describing what was detected in the image.
    - `rectangle` BoundingRect — A bounding box for an area inside an image.
      - `x` integer — X-coordinate of the top left point of the area, in pixels.
      - `y` integer — Y-coordinate of the top left point of the area, in pixels.
      - `w` integer — Width measured from the top-left point of the area, in pixels.
      - `h` integer — Height measured from the top-left point of the area, in pixels.
    - `object` string, nullable — Label for the object.
    - `confidence` number, double — Confidence score of having observed the object in the image, as a value ranging from 0 to 1.
    - `parent` ObjectHierarchy, nullable — An object detected inside an image.
      - `object` string, nullable — Label for the object.
      - `confidence` number, double — Confidence score of having observed the object in the image, as a value ranging from 0 to 1.
      - `parent` ObjectHierarchy — recursive
  - `brands` DetectedBrand[], nullable — Array of brands detected in the image.
    - `name` string, nullable — Label for the brand.
    - `confidence` number, double — Confidence score of having observed the brand in the image, as a value ranging from 0 to 1.
    - `rectangle` BoundingRect — A bounding box for an area inside an image.
      - `x` integer — X-coordinate of the top left point of the area, in pixels.
      - `y` integer — Y-coordinate of the top left point of the area, in pixels.
      - `w` integer — Width measured from the top-left point of the area, in pixels.
      - `h` integer — Height measured from the top-left point of the area, in pixels.
  - `requestId` string, nullable — Id of the REST API request.
  - `metadata` ImageMetadata, nullable — Image metadata.
    - `width` integer — Image width, in pixels.
    - `height` integer — Image height, in pixels.
    - `format` string, nullable — Image format.

## Other responses

- `default` — Error response.

---

[API](https://skmtc.dev/azure/apis/computer-vision-client.md) · [All operations](https://skmtc.dev/azure/apis/computer-vision-client/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/computer-vision-client/revisions/5fb9df827f90/schema)