Get Custom Metadata Schema

About

This endpoint returns the custom metadata fields that have been used across the Vision Events in a given Use Case. Because custom metadata is defined per event rather than by a fixed schema, use this to discover which fields exist and their types before building event queries or dashboard filters.

HTTP API

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 /vision-events/custom-metadata-schema/{useCaseId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json

curl -L \
  --request GET \
  --url 'https://api.roboflow.com/vision-events/custom-metadata-schema/{useCaseId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Accept: application/json'

const response = await fetch("https://api.roboflow.com/vision-events/custom-metadata-schema/{useCaseId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
  }
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.roboflow.com/vision-events/custom-metadata-schema/{useCaseId}"
headers = {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

{
  "solution": "text",
  "fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "error": "text"
}

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

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

{
  "error": "Insufficient permissions for this resource."
}

Python SDK

Discover the custom metadata fields that have been used in events for a given use case. This is useful for building queries with customMetadataFilters.

import roboflow

roboflow.login()

rf = roboflow.Roboflow()
ws = rf.workspace()

schema = ws.get_vision_event_metadata_schema("a1b3c8e1")

for field, info in schema["fields"].items():
    print(f"{field}: {info['types']}")

The response contains a fields dict mapping each discovered field name to its observed types (e.g., ["string"], ["number"]). You can use this information to construct typed filters when querying events:

page = ws.query_vision_events(
    "a1b3c8e1",
    customMetadataFilters=[
        {"field": "temperature", "operator": "gt", "value": 70, "type": "number"}
    ],
)

For more details, see the REST API reference.

MCP Server

Connect your AI agent to the MCP Server and it can read the custom metadata schema with these tools: