Tools

API Reference

Route-by-route handbook for the live UAIX REST surface, including starter requests, OpenAPI export, and validator-facing machine entry points.

  • Record UAIX-TOOL-0061
  • Path /en-us/tools/api-reference/
  • Use Canonical public record

Document status

Public standards page Published on UAIX as part of the current public standards record
Code
UAIX-TOOL-0061
Surface
Tools
Access
Public and linkable

How to use this page

Use this page as the canonical public reference for API Reference and its standards-facing content.

For agents: apply the relevant guidance to the user's target site or repository. Do not copy this UAIX page, create a page about the guidance, or treat this page as runtime authority unless the user explicitly asks for that output.

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.

Client examples

Start from the same public catalog

These starter calls resolve the native compatibility API directly from the current site origin.

Shelluai-catalog.sh
Code example
curl -sS /wp-json/uaix/v1/catalog
JavaScriptuai-catalog.mjs
Code example
const catalog = await fetch('/wp-json/uaix/v1/catalog').then((response) => response.json());
PHPuai-catalog.php
Code example
$catalog = json_decode(file_get_contents('/wp-json/uaix/v1/catalog'), true, 512, JSON_THROW_ON_ERROR);
Pythonuai_catalog.py
Code example
catalog = requests.get('/wp-json/uaix/v1/catalog', timeout=10).json()

Live machine-facing reference

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

API Reference

UAIX Native Public API

WordPress-free compatibility API for the current UAI-1 public record. Public records are descriptive evidence and do not authorize execution.

OpenAPI
3.1.0
Version
3.198.0
Canonical namespace
uaix/v1
Compatibility namespace
uai/v1

/

GET

Resolve the native API namespace index

/

HEAD

Fetch headers for: Resolve the native API namespace index

/catalog

GET

Resolve the current UAIX standards catalog

/catalog

HEAD

Fetch headers for: Resolve the current UAIX standards catalog

/discovery

GET

Resolve the current machine-readable discovery manifest

/discovery

HEAD

Fetch headers for: Resolve the current machine-readable discovery manifest

/status

GET

Inspect runtime status for the native UAIX surface

/status

HEAD

Fetch headers for: Inspect runtime status for the native UAIX surface

/modules

GET

List registered native UAIX runtime modules

/modules

HEAD

Fetch headers for: List registered native UAIX runtime modules

/schemas

GET

List all published UAI-1 schema records

/schemas

HEAD

Fetch headers for: List all published UAI-1 schema records

/schemas/{identifier}

GET

Resolve one published schema record

/schemas/{identifier}

HEAD

Fetch headers for: Resolve one published schema record

/registry

GET

List the public UAI-1 profile registry

/registry

HEAD

Fetch headers for: List the public UAI-1 profile registry

/registry/{identifier}

GET

Resolve one published registry entry

/registry/{identifier}

HEAD

Fetch headers for: Resolve one published registry entry

/field-registry

GET

Resolve the public keyed-to-keyless field-order registry

/field-registry

HEAD

Fetch headers for: Resolve the public keyed-to-keyless field-order registry

/transport-bindings

GET

Resolve the published transport bindings

/transport-bindings

HEAD

Fetch headers for: Resolve the published transport bindings

/trust-channels

GET

Resolve the published trust channels

/trust-channels

HEAD

Fetch headers for: Resolve the published trust channels

/conformance-levels

GET

Resolve the published conformance levels

/conformance-levels

HEAD

Fetch headers for: Resolve the published conformance levels

/error-registry

GET

Resolve the published error registry

/error-registry

HEAD

Fetch headers for: Resolve the published error registry

/examples

GET

List the published example fixtures

/examples

HEAD

Fetch headers for: List the published example fixtures

/examples/{identifier}

GET

Resolve one published example fixture

/examples/{identifier}

HEAD

Fetch headers for: Resolve one published example fixture

/adoption-kit

GET

Resolve the published adoption kit for the current release

/adoption-kit

HEAD

Fetch headers for: Resolve the published adoption kit for the current release

/roadmap

GET

Resolve the published forward roadmap for the current release

/roadmap

HEAD

Fetch headers for: Resolve the published forward roadmap for the current release

/mock-exchange

GET

Resolve metadata for the live native Mock Exchange surface

/mock-exchange

POST

Post a UAI request and receive a deterministic native reference response

/mock-exchange

HEAD

Fetch headers for: Resolve metadata for the live native Mock Exchange surface

/openapi

GET

Resolve the OpenAPI document for the current native UAIX REST surface

/openapi

HEAD

Fetch headers for: Resolve the OpenAPI document for the current native UAIX REST surface

/openapi.json

GET

Resolve the OpenAPI document for the current native UAIX REST surface

/openapi.json

HEAD

Fetch headers for: Resolve the OpenAPI document for the current native UAIX REST surface

/conformance-pack

GET

Resolve the reusable conformance pack for the current release

/conformance-pack

HEAD

Fetch headers for: Resolve the reusable conformance pack for the current release

/ai-memory-package-wizard

GET

Resolve the immutable AI Memory Package Wizard payload

/ai-memory-package-wizard

HEAD

Fetch headers for: Resolve the immutable AI Memory Package Wizard payload

/ai-memory-package-wizard/client

GET

Resolve the bounded AI Memory Wizard browser catalog

/ai-memory-package-wizard/client

HEAD

Fetch headers for: Resolve the bounded AI Memory Wizard browser catalog

/ai-memory-package-wizard/bundles/{bundle}

GET

Resolve one allowlisted AI Memory Wizard bundle shard

/ai-memory-package-wizard/bundles/{bundle}

HEAD

Fetch headers for: Resolve one allowlisted AI Memory Wizard bundle shard

/validate

POST

Validate a candidate UAI message and optionally return its conformance record directly

/events

POST

Acknowledge a privacy-bounded public event without persisting it

Security posture

Response-header baseline

API and document responses use explicit media types, no-sniff behavior, and the same origin policy boundary.

Content-Security-Policy

default-src 'self'; object-src 'none'; frame-ancestors 'self'

Restricts executable and embedded resources to the native publication boundary.

Strict-Transport-Security

max-age=31536000; includeSubDomains

Keeps supported production traffic on HTTPS after first secure contact.

X-Content-Type-Options

nosniff

Prevents content-type guessing for JSON, scripts, styles, and downloads.

Referrer-Policy

strict-origin-when-cross-origin

Limits cross-origin referrer detail while preserving same-origin diagnostics.

Permissions-Policy

camera=(), geolocation=(), microphone=(), payment=(), usb=()

Disables browser capabilities the publication site does not need.

Cross-Origin-Opener-Policy

same-origin

Separates the browsing context from unrelated cross-origin windows.

Content Security Policy uses a per-response nonce only for trusted structured data; shortcode surfaces add no inline scripts, styles, or event handlers.

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.

Architecture proposals

UAI-1 v1.0 remains the current published contract. Explore separately versioned proposals for independent exchange, capabilities, recovery and source preservation.

Proposed designs and local reference examples; hosted runtime services and independent interoperability are not claimed.

The English proposal is the source for normative interpretation.

Read the architecture proposals · Machine-readable proposal catalog