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	Discovery	Use when your agent has a dietary query and needs restaurant candidates.
Enrich	Bring your own place	Use when your product already has a restaurant or place record to match.
Decision	User-specific verdict	Use when you need fit, not_fit, or unknown for a profile and evidence state.
Restaurant Details	Supporting lookup	Use after Search or Enrich when one result needs the full structured record.

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