Documentation

For developers

Technical reference for the /walt/* endpoints AI agents use to read and act on a Walt-enabled site.

When a site’s front desk is enabled, Walt exposes a small, stable set of endpoints under the /walt/* path on the site’s own hostname (for example, https://www.yourbusiness.com/walt/search). They’re designed to be discovered and used by AI systems directly. Reads are GET; the contact surface accepts POST. All support OPTIONS for CORS preflight.

Capability document — GET /walt/

The entry point. Lists every available surface with a short usage hint, so an agent can start here and discover the rest. The Site Index (/walt/search) is the read path; /walt/contact and approved /walt/actions are the write paths.

Search the Site Index — GET /walt/search

The read path. Searches a compiled index of the site’s content and returns concise, structured results. Two input forms:

  • Query string: GET /walt/search?q=opening+hours
  • Path term: GET /walt/search/opening-hours

Read /walt/search/schema to discover the exact input forms, matching semantics, and response shape before querying.

Search schema — GET /walt/search/schema

Returns the search input forms, matching semantics, and response shape as machine-readable metadata.

Approved actions — GET /walt/actions

Returns the set of customer actions the business has approved for agents (application/json) — the catalogue of write operations available beyond plain contact.

Contact — GET and POST /walt/contact

The structured contact surface; the general write path.

  • GET /walt/contact describes the endpoint and the fields it accepts.
  • POST /walt/contact submits a structured contact request on behalf of a customer. Submissions land in the business’s request inbox for review.

Begin a contact flow — GET /walt/contact/start

Returns what an agent needs to begin a guided, multi-step contact interaction.

Events — GET /walt/events

A stream of site events relevant to agents.

Notes for agent authors

  • Start at /walt/ — it enumerates everything available on a given site; don’t hard-code surfaces.
  • Read /walt/search/schema before searching — input forms and response shapes are described there.
  • Reads are safe and idempotent. Only POST /walt/contact and approved /walt/actions cause writes, and those are reviewed by the business.
  • Endpoints are per-hostname — always call them on the site’s own domain.