Host API v2

Host API v2 is a shared HTTP contract for creating, reading, updating, and deleting Resources managed by a Host. A Form defines Resource-specific meaning; the Host implements the Form; and the client operates with both in view.

Read the specification

• Overview and concepts — Form, Host, Resource, Operation, and ownership boundaries.
• HTTP API — Discovery, requests/responses, authorization, generations, retries, and errors.
• Form requirements — Resource-specific meaning that Form authors specify.
• Request-to-delete examples — A non-normative transcript with a fictional Host and Form.
• Migration from v1 — Questions for an explicit product migration, not an automatic conversion procedure.

The overview, HTTP API, and Form requirements are normative. Examples and migration guidance explain the specification.

Suggested reading order

Refer to the v2 glossary for terminology.

• Users: Follow the fictional HTTP walkthrough in Getting started, then read the fuller request/response examples.
• Form authors: Use Form requirements to define spec, observed, output, and failure behavior.
• Client implementers: Read the client design guide for intent records, replay deadlines, Operations, and generation conflicts; then consult the HTTP retry contract.
• Host implementers: Start with the Host implementation guide for durability, then read the overview, HTTP API, and each implemented Form.