Skip to main content

API reference

The reviewed Gnaww developer contract contains 13 operations.

MethodPathOperation IDAuthentication
GET/health/livegetApiLivenessPublic
GET/health/readygetApiReadinessPublic
POST/v1/interpretinterpretPrintRequirementtransform:write
POST/v1/interpret/continuecontinuePrintRequirementInterpretationtransform:write
POST/v1/transformtransformPrintRequirementtransform:write
POST/v1/matchesmatchPrintDemandmatch:write
POST/v1/matches/universematchPrintDemandUniversematch:write
POST/v1/recipesresolveReciperecipes:write
GET/v1/recipes/{recipe_id}getReciperecipes:read
POST/v1/recipes/{recipe_id}/matchesmatchReciperecipes:read + match:write
POST/v1/specificationscreateSpecificationspecifications:write
GET/v1/specifications/{specification_id}getSpecificationspecifications:read
GET/v1/producer-capabilities/{profile_id}getProducerCapabilityProfileproducer-capabilities:read

This list is generated and governed from the reviewed gnaww-developer-v0.1 contract, not from the complete implementation OpenAPI document.

POST /v1/interpret returns gnaww.interpretation_result v0.2. The result is job-centric: top-level intent and shared context sit alongside jobs[] and scoped questions[]; canonical GJS, Recipe and SpecMatch readiness sit on the relevant Job. /v1/interpret/continue uses the corresponding v0.2 public continuation contract with answers keyed by question_id.

The base interpretation operation continues to require transform:write. When functional or unfamiliar intent reaches controlled Production Solution Candidate evaluation, the caller must also hold match:write and pass the active matching plan gate before Gnaww can run candidate-level SpecMatch against authorised controlled capability. A transform-only or non-entitled caller keeps the functional requirement in review rather than receiving a fabricated capability answer. When candidate SpecMatch actually runs, result-level truth.specmatch_performed is true; the Job-level specmatch field still describes readiness of canonical Job demand and may remain basis: none. Candidate capability fit is not price, current availability, current capacity or producer acceptance, and a viable candidate still requires explicit production-solution acceptance before canonical completion.

API reference

This reference is governed by the reviewed gnaww-developer-v0.1 contract. Only operations included in that contract form part of the Gnaww Developer API. Request and response schemas are generated from the same canonical OpenAPI definition.