usewrit-app Agent API

openapi: 3.2.0
info:
  title: Writ Agent API
  version: 0.1.0
  license:
    name: MIT
    identifier: MIT
  description: 'Loopback HTTP API of the Writ local agent (`writ-agentd`), the daemon embedded in the

    Writ desktop app and the self-host build. This document is generated against the Rust

    daemon source (`writ-agent/src/local/`), which is the wire truth.


    ## Transport


    - Plain HTTP on `127.0.0.1:8131` (default; `WRIT_PORT` env overrides).

    - Optional HTTPS twin on `127.0.0.1:8132`, served with a certificate minted by a

    per-install, name-constrained local CA (`~/.writ/tls/ca.pem`). Clients must trust that

    CA file (or pin it) to use the TLS port; the payloads are identical on both ports.

    - The daemon enforces a DNS-rebind guard: `Host`/`Origin` must be loopback. Talk to

    `127.0.0.1`, not `localhost`.


    ## Errors


    Domain errors are JSON `{"error": "", "code": ""}` (see the

    `Error` schema). Codes include `bad_request`, `unauthorized`, `forbidden`, `not_found`,

    `vault_locked` (HTTP 423), `too_many_requests`, `device_capacity` (HTTP 409),

    `captcha_required` (HTTP 402), `internal`.


    **Caveat:** some 4xx bodies are `text/plain`, not JSON — axum framework rejections

    (e.g. a JSON body that fails to deserialize returns

    `Failed to deserialize the JSON body into the target type: missing field ''url''` as

    plain text with a 4xx status). Clients must tolerate non-JSON error bodies.


    ## List envelopes


    The wire is deliberately documented as-is (SDKs normalize; this spec does not):


    - `{"data": [...], "count": n}` — workflows, personas, persona runs, secrets, files, keys

    - `{"data": [...], "count": n, "total": n}` — runs

    - **bare JSON array** — monitors, monitor selectors, extractors, automations,

    `/v1/changes/recent`

    - bespoke objects — `/v1/monitors/{id}/changes`, `/v1/data`, the workflow-data table'
servers:
- url: http://127.0.0.1:8131
  description: Plain-HTTP loopback listener (default port; WRIT_PORT overrides).
- url: https://127.0.0.1:8132
  description: HTTPS twin of the same API, terminated with a certificate from the per-install local CA at ~/.writ/tls/ca.pem. Trust that CA (or pin it) in your HTTP client.
security:
- bearerAuth: []
tags:
- name: Agent
  description: Daemon status and deep health (both require auth like every other route).
paths:
  /v1/agent:
    get:
      operationId: getAgentStatus
      tags:
      - Agent
      summary: Lightweight agent status
      description: 'Enriched daemon status for UIs/CLIs: version, active run count, scheduler liveness, and the warm-browser hint. Requires auth (used as the SDK discovery liveness probe).'
      responses:
        '200':
          description: Daemon status snapshot.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/health:
    get:
      operationId: getHealth
      tags:
      - Agent
      summary: Deep health probe
      description: 'Self-checking health: SQLCipher reachability, keyring availability, scheduler liveness, and cloud-link reflection. No secrets are included. Requires auth.'
      responses:
        '200':
          description: Health report (`status` is `ok` or `degraded`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Error:
      type: object
      description: 'The daemon''s domain error body. NOTE: some 4xx responses (axum framework rejections) are `text/plain` instead of this JSON shape. Certain codes attach extra fields (e.g. `device_capacity` adds `would_use_units_per_min` / `budget_units_per_min`; `captcha_required` adds `captcha_type` / `url`).'
      required:
      - error
      - code
      properties:
        error:
          type: string
          description: 'Human-readable message (e.g. `not found: workflow 999999`).'
        code:
          type: string
          description: 'Stable machine code: `bad_request`, `unauthorized`, `forbidden`, `not_found`, `vault_locked`, `too_many_requests`, `captcha_required`, `device_capacity`, `cloud_unreachable`, `db_error`, `io_error`, `json_error`, `internal`, …'
      additionalProperties: true
    Health:
      type: object
      description: Deep health probe (`GET /v1/health`). No secrets.
      required:
      - status
      - version
      - cipher_present
      - db_ok
      - keyring_ok
      - active_runs
      - scheduler
      - warm_browser
      - cloud_link
      properties:
        status:
          type: string
          enum:
          - ok
          - degraded
        version:
          type: string
        cipher_present:
          type: boolean
          description: SQLCipher is active on the store.
        db_ok:
          type: boolean
          description: Cipher active AND a trivial query succeeded.
        keyring_ok:
          type: boolean
          description: OS keyring reachability (reported true when the file-fallback vault is configured).
        active_runs:
          type: integer
        scheduler:
          type: object
          required:
          - last_tick_at
          - due_monitors
          properties:
            last_tick_at:
              type:
              - string
              - 'null'
            due_monitors:
              type: integer
        warm_browser:
          type: boolean
        cloud_link:
          type: object
          description: Cloud-link reflection (always unlinked in the cloud-free OSS build).
          required:
          - linked
          - account_id
          properties:
            linked:
              type: boolean
            account_id:
              type:
              - string
              - 'null'
              description: Opaque server-side account id when linked; null otherwise.
    AgentStatus:
      type: object
      description: Lightweight daemon status (`GET /v1/agent`).
      required:
      - status
      - version
      - active_runs
      - encrypted
      - due_monitors
      - warm_browser
      properties:
        status:
          type: string
          const: ok
        version:
          type: string
          description: Daemon crate version.
        active_runs:
          type: integer
          description: Number of runs currently executing in the engine.
        encrypted:
          type: boolean
          description: Always true — the store is SQLCipher-encrypted.
        due_monitors:
          type: integer
          description: Monitors currently due per the scheduler's last tick.
        last_tick_at:
          type:
          - string
          - 'null'
          description: RFC3339 timestamp of the scheduler's last tick (null before the first tick).
        warm_browser:
          type: boolean
          description: Whether a warm browser is available right now (OR'd with live runs).
  responses:
    Unauthorized:
      description: Missing/invalid bearer token, or the Origin/Host guard rejected the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: "Every route (including `/v1/agent` and `/v1/health`) requires\n`Authorization: Bearer <token>`. Token families:\n\n- `wlt_…` — the runtime token from `runtime.json` (full access, used by the desktop\n  UI and SDK discovery).\n- `wlk_…` — a scoped API key minted via `POST /v1/keys` (CSV scopes `read|run|admin`;\n  `/v1/keys` itself requires the full-access token).\n- `wlo_…` — an OAuth 2.1 access token from the daemon's local authorization server\n  (`run` scope).\n\nTreat the token as an opaque string. The daemon additionally enforces a loopback\nOrigin/Host DNS-rebind guard.\n"