工具

API参考

实时 UAIX REST 表面的逐条路线手册,包括启动器请求、OpenAPI 导出和面向验证器的机器入口点。

  • 记录 UAIX-TOOL-0061
  • 路径 /zh-cn/tools/api-reference/
  • 用途 规范公共记录

文档状态

公共标准页面 作为当前公共标准记录的一部分发布在 UAIX 上
代码
UAIX-TOOL-0061
页面类型
工具
访问
公开且可链接

如何使用此页面

将此页面用作 API参考 及其标准内容的规范公共参考。

对于代理:请将相关指南应用于用户的目标站点或代码库。除非用户明确要求该输出,否则不要复制此 UAIX 页面、创建有关该指南的页面,也不要将此页面视为运行时权限。

此页面的用途

使用此页面作为实时 UAIX REST 表面的面向机器的手册。它将当前目录、发现、路线图、架构、注册表、示例、验证器、采用套件、OpenAPI、模拟交换和一致性包路由转换为人类可读的启动参考。

何时使用它

  • 当实施者想要精确的非区域设置 REST 基本路径和路由清单时。
  • 当工具构建者需要启动请求、采用包、前瞻性计划边界和 OpenAPI 文档而不是对站点进行逆向工程时。
  • 当发布审核者想要验证公共文档、面向机器的路线、路线图边界和验证器证据是否都指向同一版本时。

通过现场表面的最快路线

  1. 解决当前/wp-json/uaix/v1/catalog路线第一。
  2. 从中获取一个模式或示例模式, 注册表, 和示例.
  3. 拉取发布的领养套件当您需要最短的可重复使用的入门包时。
  4. 提交验证器运行验证器或面向机器的/wp-json/uaix/v1/validate路线。
  5. 使用一致性包当该运行需要作为更广泛的发布证据进行传播时。
  6. 使用/wp-json/uaix/v1/roadmap当自动化也需要当前的未来工作边界时。

路线等级图

  • 发现 GET 路线:目录、发现、模式、注册表、字段注册表、示例、传输绑定、信任通道、错误注册表、一致性级别、路线图、OpenAPI、采用工具包和一致性包路由发布当前的机器可读记录。
  • 执行POST路线:验证和模拟交换路由接受候选 JSON 并且应被视为无存储执行表面,而不是可爬行的登陆页面。
  • 人类引用途径:当散文、边界和后续步骤很重要时,公共声明应引用以语言环境为前缀的页面,例如 UAI-1、Validator、Adoption Kit、Conformance Pack、Roadmap 和 Changelog。
  • 下载表格:可下载的 JSON 数据包是相同公共记录的便捷形式,而不是单独的权限。

此页面发布的内容

  • 面向机器的逐条路线参考。
  • 用于发现、配置文件查找、验证、入门包获取和路线图解析的入门请求示例。
  • 当前 OpenAPI 3.1 导出为实时 REST 表面。
  • 直接链接回规范的公共页面,以散文形式解释相同的记录。

路由级启动器调用

当您希望在curl、PowerShell、Python 或TypeScript 中进行实时目录、示例和验证器调用而不需要对路由表面进行逆向工程时,请使用下面的公共代码片段。

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
代码示例
curl -sS /wp-json/uaix/v1/catalog
JavaScriptuai-catalog.mjs
代码示例
const catalog = await fetch('/wp-json/uaix/v1/catalog').then((response) => response.json());
PHPuai-catalog.php
代码示例
$catalog = json_decode(file_get_contents('/wp-json/uaix/v1/catalog'), true, 512, JSON_THROW_ON_ERROR);
Pythonuai_catalog.py
代码示例
catalog = requests.get('/wp-json/uaix/v1/catalog', timeout=10).json()

实时面向机器的参考

使用下面的参考作为路线布局、启动器调用和 OpenAPI 导出的当前公共源。

API参考

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.

下一步

继续领养套件如果您需要已发布的第一证明捆绑包,一致性包如果您需要更广泛的可重用 JSON 数据包,请打开/wp-json/uaix/v1/roadmap如果自动化需要未来工作边界,或者返回到验证器当下一个任务正在运行或导出一个具体的验证检查时。

架构提案

UAI-1 v1.0 仍是当前发布的契约。独立版本的提案涵盖独立交换、能力声明、故障恢复和源记录保留。

这些内容是提议的设计和本地参考示例,并不声称提供托管运行时服务或已验证独立互操作性。

规范解释以英文提案为源文;此界面摘要不代表已审定的规范译文。

阅读英文架构提案 · 机器可读提案目录