Skip to content
Get Started Free

API Reference

What this page is for

Use this page as the machine-facing handbook for the live UAIX REST surface. It translates the current catalog, discovery, roadmap, schema, registry, example, validator, adoption-kit, OpenAPI, mock-exchange, and conformance-pack routes into one human-readable launch reference.

When to use it

  • When an implementer wants the exact non-locale REST base path and route inventory.
  • When a tool builder needs starter requests, the adoption bundle, the forward-plan boundary, and an OpenAPI document instead of reverse-engineering the site.
  • When a launch reviewer wants to verify that the public documentation, machine-facing routes, roadmap boundaries, and validator evidence all point at the same release.

Fastest route through the live surface

  1. Resolve the current /wp-json/uaix/v1/catalog route first.
  2. Fetch one schema or example from Schemas, Registry, and Examples.
  3. Pull the published Adoption Kit when you need the shortest reusable onboarding packet.
  4. Submit a validator run through Validator or the machine-facing /wp-json/uaix/v1/validate route.
  5. Use the Conformance Pack when that run needs to travel as broader release evidence.
  6. Use /wp-json/uaix/v1/roadmap when automation also needs the current future-work boundary.

Route class map

  • Discovery GET routes: catalog, discovery, schemas, registry, field registry, examples, transport bindings, trust channels, error registry, conformance levels, roadmap, OpenAPI, adoption kit, and conformance pack routes publish current machine-readable records.
  • Execution POST routes: validation and mock-exchange routes accept candidate JSON and should be treated as no-store execution surfaces, not crawlable landing pages.
  • Human citation routes: locale-prefixed pages such as UAI-1, Validator, Adoption Kit, Conformance Pack, Roadmap, and Changelog are the pages a public claim should cite when prose, boundaries, and next steps matter.
  • Download forms: downloadable JSON packets are convenience forms of the same public records, not separate authorities.

What this page publishes

  • A route-by-route machine-facing reference.
  • Starter request examples for discovery, profile lookup, validation, onboarding-bundle fetch, and roadmap resolution.
  • The current OpenAPI 3.1 export for the live REST surface.
  • Direct links back to the canonical public pages that explain the same record in prose.

Route-level starter calls

Use the public snippets below when you want the live catalog, example, and validator calls in curl, PowerShell, Python, or TypeScript without reverse-engineering the route surface.

[uaix_client_examples context=”api”]

Live machine-facing reference

Use the reference below as the current public source for route layout, starter calls, and OpenAPI export.

[uaix_api_reference][uaix_security_header_posture context=”api”]

Next step

Continue to Adoption Kit if you need the published first-proof bundle, Conformance Pack if you need the broader reusable JSON packet, open /wp-json/uaix/v1/roadmap if automation needs the future-work boundary, or return to Validator when the next task is running or exporting one concrete proof check.