Skip to main content

Get Media Annotations

GEThttps://api.perceptpixel.com/v1/media/:uid/annotations

Get the annotations for a media item.

Path Parameters​

  • :uid - The unique identifier of the media item.

Response​

Returns annotations of the media item.

{
  "captions": [
    {
      "text": "a cat sitting on a staircase",
      "confidence": 1.0,
      "boundingBox": {}
    }
  ],
  "tags": [
    {
      "name": "cat",
      "confidence": 1.0
    },
    {
      "name": "sitting",
      "confidence": 0.7
    }
  ]
}

Types​

The response type is mocked in Typescript below. The Caption and Tag types are from the Media Upload API.

type Annotations = {
  captions: Caption[];
  tags: Tag[];
};