DocsGET /v1/metadata
Docs
GET /v1/metadata
Public, unmetered dataset metadata and capability discovery for Compass DaaS.
Request
| Field | Type | Notes |
|---|---|---|
| Authentication | none | Public endpoint. No API key or auth header is required. |
| Quota | none | Does not consume Compass credits and is available to all tiers. |
| Response status | 200 | 304 | 500 | Returns JSON, a cache revalidation response, or an internal error. |
curl "https://api.compassfoodtechnologies.com/v1/metadata"
Response
MetadataResponse: 22 contract leaves. A row is one contract leaf. Optional leaves, missing restaurant evidence, and fast mode can omit fields. This count is the schema, not a promise that every response contains every field.
| Field | Type | Notes |
|---|---|---|
| api_version | v1 | Required on this object. |
| available_regions[] | us | Required on this object. |
| averageVeganScore | number | Required on this object. |
| coverageByCountry | object of integer | Required on this object. |
| covered_geography.code | US | Required on this object. |
| covered_geography.excludes[] | string | Required on this object. |
| covered_geography.includes | string | Required on this object. |
| cuisineDistribution | object of integer | Required on this object. |
| datasetVersion | string | Required on this object. |
| lastUpdated | string (date-time) | Required on this object. |
| model_versions.embedding_model | string | Required on this object. |
| model_versions.evidence_builder | string | Optional. Omitted when the value is absent. |
| model_versions.scoring | string | Required on this object. |
| scoringVersion | string | Required on this object. |
| supported_enums.confidences[] | high | medium | low | Required on this object. |
| supported_enums.decisions[] | fit | not_fit | unknown | Required on this object. |
| supported_enums.diets[] | strict_vegan | vegan_options | vegetarian | pescatarian | halal | kosher | low_fodmap | Required on this object. |
| supported_enums.evidence_tiers[] | A | B | Required on this object. |
| supported_enums.evidence_types[] | menu_item | review_signal | external_source | user_report | restaurant_declared | Required on this object. |
| supported_enums.risk_flags[] | cross_contamination_risk | limited_evidence | stale_data | third_party_unverified | user_report_only | language_barrier | Required on this object. |
| totalRestaurants | integer | Required on this object. |
| totalWithVeganScore | integer | Required on this object. |
Abridged MetadataResponse example — 18 of 22 contract leaves. Illustrative values, not a live payload.
{
"datasetVersion": "2026-05-04",
"totalRestaurants": 374041,
"totalWithVeganScore": 360000,
"lastUpdated": "2026-05-04T09:30:00.000Z",
"coverageByCountry": {
"US": 374041
},
"averageVeganScore": 72,
"scoringVersion": "v4.0-deterministic",
"cuisineDistribution": {
"Vegan": 18250,
"Italian": 14600
},
"api_version": "v1",
"supported_enums": {
"diets": [
"strict_vegan",
"vegan_options",
"vegetarian",
"pescatarian",
"halal",
"kosher",
"low_fodmap"
],
"decisions": [
"fit",
"not_fit",
"unknown"
],
"confidences": [
"high",
"medium",
"low"
],
"risk_flags": [
"cross_contamination_risk",
"limited_evidence",
"stale_data",
"third_party_unverified",
"user_report_only",
"language_barrier"
],
"evidence_tiers": [
"A",
"B"
],
"evidence_types": [
"menu_item",
"review_signal",
"external_source",
"user_report",
"restaurant_declared"
]
},
"available_regions": [
"us"
],
"model_versions": {
"scoring": "v4.0-deterministic",
"embedding_model": "voyage-4-large-512d-v1"
}
}