Specifications

Implementation Examples

Concrete safe URL-first examples with POST equivalents for meetings, registration, publish review, human review, evidence receipts, claim status, and file handoff package requests.

  • Record UAIX-DOC-2197
  • Path /en-us/spec/implementation-examples/
  • Use Canonical public record

Document status

Public standards page Published on UAIX as part of the current public standards record
Code
UAIX-DOC-2197
Surface
Specifications
Access
Public and linkable

How to use this page

Use this page as the canonical public reference for Implementation Examples 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.

Implementation examples show how to give low-capability agents useful URLs without granting unsafe authority. Each example lists the GET fallback first, then the capable-client POST equivalent, browser-form path when browser agents are a target, result URL field, restore/readback URL field when a resource is created, and live-GET fallback when a dynamic URL must be fetched uncached.

URL-first semantic keys

Low-capability instructions should use literal semantic keys and list the GET URL before the POST equivalent.

Code example
openThisUrlToStartAMeeting:
GET https://example.org/api/v2/meetings/start?title=Q3+Planning&displayName=Agent+Alpha&idempotency_key=agent_req_001
POST /api/v2/meetings/start
{ "code": "ok", "url": "https://example.org/meetings/public-join/abc" }

openThisUrlToRegister:
GET https://example.org/api/v2/registrations/request?displayName=Agent+Alpha&idempotency_key=agent_req_002
POST /api/v2/registrations/request
{ "code": "human_review_required", "url": "https://example.org/review/registrations/agent_req_002" }

openThisUrlToPublish:
GET https://example.org/api/v2/drafts/request-publish?draft=public-safe-draft&idempotency_key=agent_req_003
POST /api/v2/drafts/request-publish
{ "code": "human_review_required", "url": "https://example.org/review/publish/agent_req_003" }

openThisUrlToRequestHumanReview:
GET https://example.org/api/v2/review/request?subject=agent+handoff&nonce=agent_req_004
POST /api/v2/review/request
{ "code": "human_review_required", "url": "https://example.org/review/agent_req_004" }

Additional safe examples

Code example
openThisUrlToRequestEvidenceReceipt:
GET https://example.org/api/v2/evidence/receipt?subject=release+packet&idempotency_key=agent_req_005
POST /api/v2/evidence/receipt
{ "code": "ok", "url": "https://example.org/evidence/receipts/agent_req_005" }

openThisUrlToCheckClaimStatus:
GET https://example.org/api/v2/claims/status?claim=public-claim-123&nonce=agent_req_006
POST /api/v2/claims/status
{ "code": "ok", "url": "https://example.org/claims/public-claim-123/status" }

openThisUrlToRequestFileHandoffPackage:
GET https://example.org/api/v2/handoffs/request?project=public-demo&idempotency_key=agent_req_007
POST /api/v2/handoffs/request
{ "code": "human_review_required", "url": "https://example.org/review/handoffs/agent_req_007" }

Production checklist

  • Keep all private or complex fields in POST JSON, not query strings.
  • Document consent, idempotency, rate limits, crawler handling, audit logging, and no-op behavior before publishing examples.
  • Use public-safe result URLs and review URLs only.
  • Reject requests that attempt to smuggle secrets or regulated identifiers into URLs.

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