Get Image Metadata Schema

Retrieve the per-image metadata keys used across Vision Events in a Use Case.

About

This endpoint returns the image metadata keys that events in a Use Case have used, with the value types seen for each key. Use it to discover which keys exist, since image metadata is set per event rather than by a fixed schema.

Keys are for discovery and display only. You cannot filter event queries on them yet. For event-level keys, use Get Custom Metadata Schema instead.

HTTP API

Required scope: vision-events:read

Get Image Metadata Schema

get

Retrieve the per-image metadata keys used by events in a given use case. Keys are listed for discovery only. They cannot be used as query filters.

Authorizations

AuthorizationstringRequired

Roboflow API key passed as a Bearer token.

Path parameters

useCaseIdstringRequired

The use case ID.

Responses

200

Per-image metadata schema.

application/json

useCaseIdstringOptional

403

Insufficient permissions for this resource.

application/json

get/vision-events/image-metadata-schema/{useCaseId}

GET /vision-events/image-metadata-schema/{useCaseId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "useCaseId": "text",
  "fields": {
    "verdict": {
      "types": [
        "string"
      ]
    },
    "angle": {
      "types": [
        "number"
      ]
    },
    "rechecked": {
      "types": [
        "boolean"
      ]
    }
  }
}

A key stays listed until its data ages out, so a key can appear after the last event that used it was replaced.