usewrit-app Vault API

openapi: 3.2.0
info:
  title: Writ Agent Vault 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: Vault
  description: App-lock control surface (status / lock / unlock).
paths:
  /v1/vault/status:
    get:
      operationId: getVaultStatus
      tags:
      - Vault
      summary: App-lock status
      description: 'Non-secret lock snapshot: `{enabled, locked, idle_timeout_secs}`.'
      responses:
        '200':
          description: Lock status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/vault/lock:
    post:
      operationId: lockVault
      tags:
      - Vault
      summary: Lock the vault now
      description: Relocks the vault immediately. Idempotent (a disabled lock is a no-op success).
      responses:
        '200':
          description: Locked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultOk'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/vault/unlock:
    post:
      operationId: unlockVault
      tags:
      - Vault
      summary: Unlock the vault
      description: Unlocks with the passphrase (verified by Argon2id re-derivation and constant-time comparison). A wrong passphrase is a 401; a disabled lock is a no-op success. The passphrase is consumed handler-side and never logged, echoed, or persisted.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VaultUnlockRequest'
      responses:
        '200':
          description: Unlocked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultOk'
        '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
    VaultOk:
      type: object
      required:
      - ok
      properties:
        ok:
          type: boolean
          const: true
    VaultStatus:
      type: object
      description: Non-secret app-lock snapshot.
      required:
      - enabled
      - locked
      - idle_timeout_secs
      properties:
        enabled:
          type: boolean
        locked:
          type: boolean
        idle_timeout_secs:
          type: integer
    VaultUnlockRequest:
      type: object
      required:
      - passphrase
      properties:
        passphrase:
          type: string
          description: Consumed handler-side; never logged, echoed, or persisted.
  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"