Get Custom Metadata Schema

Retrieve the schema of custom metadata fields that have been used in events for a given use case. This is useful for discovering what metadata fields are available for filtering in query requests.

Required scope: vision-events:read or device:read

Get Custom Metadata Schema

get

Retrieve the schema of custom metadata fields for a given use case.

Authorizations

bearerAuth

AuthorizationstringRequired

Roboflow API key passed as a Bearer token.

Path parameters

useCaseIdstringRequired

The use case ID.

Responses

200

Metadata schema.

application/json

solutionstringOptional

403

Insufficient permissions for this resource.

application/json

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

HTTPcURLJavaScriptPython

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

{
  "solution": "text",
  "fields": {
    "ANY_ADDITIONAL_PROPERTY": {
      "types": [
        "string"
      ]
    }
  }
}

Path Parameters

• :useCaseId (string, required): The use case ID.

Example Request

curl "https://api.roboflow.com/vision-events/custom-metadata-schema/a1b3c8e1" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

200

{
  "fields": {
    "production_line": {
      "types": ["string"]
    },
    "temperature": {
      "types": ["number"]
    },
    "is_overtime": {
      "types": ["boolean"]
    }
  }
}

Each field in the fields object includes:

• types (array of strings): The data types observed for this field, each one of string, number, or boolean. A field may have multiple types if different events used different types for the same key.

403