API reference

Compass DaaS v1 uses JSON over HTTPS and authenticates with a Compass API key.

Base URL and authentication

Field	Type	Notes
Base URL	string	https://api.compassfoodtechnologies.com
X-Compass-API-Key	header	Use cmp_test_* for Sandbox and cmp_live_* for paid tiers.
X-Compass-Mode	header	Optional fast or rich mode where supported. Defaults to rich.

Machine-readable contract

Use OpenAPI as the exact contract for SDK generation, agent tools, and schema validation. The human pages below explain the same v1 surface in narrative form.

Field	Type	Notes
OpenAPI JSON	url	https://compassfoodtechnologies.com/openapi.json
OpenAPI YAML	url	https://compassfoodtechnologies.com/openapi.yaml

OpenAPI JSON OpenAPI YAML

Endpoint choice

Field	Type	Notes
Search	Entry point — discovery	Search with a user profile, then Decide on the result your user selects.
Enrich	Entry point — your records	Enrich a record you already have, store the compass_id, then Decide.
Decision	The verdict	Every chain ends here: fit, not_fit, or unknown for one profile.
Changes	Supporting sync	GET /v1/changes lists created, updated, and deleted signals. It does not emit merges, and it is not a complete deletion record. See the OpenAPI contract.
Refresh	Retired	POST /v1/refresh/{compass_place_id} returns HTTP 410. It does not reserve a refresh and does not offer an immediate or manual replacement.

GUIDE supported query contract

How agents should structure Search requests and handle unsupported ambiguity.

Read reference

POST /v1/search

Natural-language restaurant discovery.

Read reference

GET /v1/metadata

Public dataset metadata and capability discovery.

Read reference

POST /v1/enrich/restaurant

Match and enrich a customer-provided restaurant.

Read reference

POST /v1/decision/restaurant-fit

Return a conservative dietary fit decision.

Read reference

FIELD vegan_score / score explanation

Response fields and the separate explanation schema.

Read reference