Sign in

v1

latestOpenAPI 3.1.02026-07-17186070.1 KB

Submit an action

Parses the body as a RequestEnvelope, registers the requestId in the agent's requests map with this Eyre request's id as the held HTTP slot, then dispatches the wrapped action. Returns when a terminal response-update arrives (typical), the host nacks (error), or the 20 s per-request behn timer fires (pending).

post/notes/~/v1

Request body

requestIdstring

Canonical Hoon @uv (base-32 with . separators every 5 chars from the right, prefixed 0v). A correlation id for the request. OPTIONAL on POST: if you omit it (or send something that isn't a valid @uv), the server mints one and returns it in the response. You only need to supply your own if you intend to poll GET /request/{requestId} or subscribe to the SSE request stream — for the common case (read the held-open POST response inline) you can leave it out entirely.

Example request

{
  "requestId": "0v3.1k7gh.j5b2m.r8nq9",
  "action": {
    "ship": "~zod",
    "name": "my-notebook-1"
  }
}

Response

Terminal or pending response from the agent

requestIdstring required

Canonical Hoon @uv (base-32 with . separators every 5 chars from the right, prefixed 0v). A correlation id for the request. OPTIONAL on POST: if you omit it (or send something that isn't a valid @uv), the server mints one and returns it in the response. You only need to supply your own if you intend to poll GET /request/{requestId} or subscribe to the SSE request stream — for the common case (read the held-open POST response inline) you can leave it out entirely.

Example response

{
  "requestId": "0v3.1k7gh.j5b2m.r8nq9",
  "body": {
    "response": {
      "host": "~zod",
      "flagName": "my-notebook-1"
    }
  }
}