API Schemas

This page defines the stable envelopes used by the human-written reference. Graph-backed records may include additional schema-valid properties as the enrichment pipeline evolves; consumers should ignore unknown fields.

Authentication schemes

Common envelopes

401, 403, 404, 409, 422, 500, 502, and 503 errors generally use ErrorResponse. Treat 409 as a conflict that may be safely resolved or retried according to the endpoint’s idempotency contract.

Core intelligence records

similarity is cosine similarity. score is a search relevance score and must not be compared to cosine similarity across endpoints.

Ontology skill response

Graph mutation requests

Labels, relationships, and properties are allowlisted by the graph schema. Requests with unknown labels, relationships, or property names return validation errors instead of executing arbitrary Cypher.

Commercial requests

The full commercial models—including plan catalogs, entitlements, reports, CLI runs, and pairing exchanges—are validated by the commercial control-plane Pydantic schemas. Use the endpoint pages for required authorization and workflow order.