api

`api`

Surface: expose as HTTP API endpoint

Children

available_to
requires_auth
rate_limit

Translations

es: api
fr: api
en: api
de: APIapi
ja: APIapi
zh: 接口
ko: api

Example — Reaching the outside world

One machine reachable many ways: a web address, notifications, an AI-tool connection, a phone shortcut, a widget — with access rules on each.

machine status_board
  accepts
    question as text
  responds with
    status as text
  expresses
    api
      path: "/status"
      method: "GET"
      available to: team
      requires auth: oauth
      rate limit: 100
    webhook
      path: "/hooks/status"
    websocket
      path: "/ws/status"
    mcp
      name: "status_tool"
    a2a
      name: "status_agent"
    page
      view
        theme: "light"
      command refresh
    shortcut phrases: ["Check status"]
    widget
      kind: "small"
    subscribes
      on "status.changed"
        compute bump
          {status: "changed"}
  implements
    compute answer
      {status: "ok"}