usewrit-app Extractors API

openapi: 3.2.0
info:
  title: Writ Agent Extractors 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: extractors
  description: Field extractors that turn a selector's captured content into typed values.
paths:
  /v1/selectors/{selector_id}/extractors:
    get:
      operationId: listExtractors
      tags:
      - extractors
      summary: List a selector's extractors
      description: The selector's field extractors (all, or `?enabled_only=true`). **Returns a bare JSON array.**
      parameters:
      - $ref: '#/components/parameters/SelectorId'
      - name: enabled_only
        in: query
        description: Only extractors with `enabled = 1`.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Bare array of extractors.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Extractor'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /v1/extractors:
    post:
      operationId: createExtractor
      tags:
      - extractors
      summary: Create an extractor
      description: Creates an extractor under an existing selector (`target_selector_id` in the body). Requires a non-empty `output_name`; `name` defaults to it.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtractorCreate'
      responses:
        '200':
          description: The created extractor row.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extractor'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /v1/extractors/{extractor_id}:
    parameters:
    - $ref: '#/components/parameters/ExtractorId'
    get:
      operationId: getExtractor
      tags:
      - extractors
      summary: Get one extractor
      description: One extractor row or 404.
      responses:
        '200':
          description: The extractor row.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extractor'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateExtractor
      tags:
      - extractors
      summary: Update an extractor
      description: Partial update; returns the refreshed row.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtractorUpdate'
      responses:
        '200':
          description: The refreshed extractor row.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extractor'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteExtractor
      tags:
      - extractors
      summary: Delete an extractor
      description: Hard-delete.
      responses:
        '200':
          description: Deletion acknowledgement.
          content:
            application/json:
              schema:
                type: object
                required:
                - deleted
                - extractor_id
                properties:
                  deleted:
                    type: boolean
                  extractor_id:
                    type: integer
                    format: int64
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /v1/extractors/{extractor_id}/toggle:
    patch:
      operationId: toggleExtractor
      tags:
      - extractors
      summary: Toggle an extractor's enabled flag
      description: Flips `enabled` and returns the refreshed extractor row. Note this route is a **PATCH** (unlike the selector toggle, which is a POST).
      parameters:
      - $ref: '#/components/parameters/ExtractorId'
      responses:
        '200':
          description: The refreshed extractor row.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extractor'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /v1/extractors/{extractor_id}/test:
    post:
      operationId: testExtractor
      tags:
      - extractors
      summary: Test a saved extractor
      description: Runs the SAVED extractor over caller-supplied content and returns the value.
      parameters:
      - $ref: '#/components/parameters/ExtractorId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtractorTestRequest'
      responses:
        '200':
          description: The extraction result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractorTestResult'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    ExtractorTestResult:
      type: object
      required:
      - extractor_id
      - output_name
      - value
      properties:
        extractor_id:
          type: integer
          format: int64
        output_name:
          type: string
        value:
          description: The extracted value (any JSON value; null on no match without default).
    ExtractorTestRequest:
      type: object
      description: Body for `POST /v1/extractors/{extractor_id}/test`.
      properties:
        content:
          type: string
          description: The content to run the saved extractor against (defaults to empty).
        content_type:
          type:
          - string
          - 'null'
          description: Accepted for API parity; the engine keys off `extract_type`.
    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
    Extractor:
      type: object
      description: One field extractor (`store::selector_extractors::SelectorExtractor`).
      required:
      - id
      - target_selector_id
      - name
      - output_name
      - enabled
      - extract_type
      - is_array
      properties:
        id:
          type: integer
          format: int64
        target_selector_id:
          type: integer
          format: int64
        name:
          type: string
        output_name:
          type: string
        enabled:
          type: integer
          description: 0/1 integer flag.
        extract_type:
          type: string
          description: One of the extraction engine types (e.g. `text`, `regex`, `css`, `number`, `json`).
        config:
          type:
          - string
          - 'null'
          description: JSON-TEXT extractor config.
        is_array:
          type: integer
          description: 0/1 integer flag.
        default_value:
          type:
          - string
          - 'null'
    ExtractorUpdate:
      type: object
      description: Partial update — same flexible shapes as create, all optional.
      properties:
        name:
          type:
          - string
          - 'null'
        output_name:
          type:
          - string
          - 'null'
        enabled:
          type:
          - boolean
          - integer
          - 'null'
        extract_type:
          type:
          - string
          - 'null'
        config:
          description: Extractor config object (or JSON string).
        is_array:
          type:
          - boolean
          - integer
          - 'null'
        default_value:
          type:
          - string
          - 'null'
    ExtractorCreate:
      type: object
      description: Create body. `enabled`/`is_array` accept booleans or 0/1 integers; `config` accepts an object or a JSON string.
      required:
      - target_selector_id
      - output_name
      properties:
        target_selector_id:
          type: integer
          format: int64
        name:
          type: string
          description: Defaults to `output_name` when empty.
        output_name:
          type: string
        enabled:
          type:
          - boolean
          - integer
          - 'null'
        extract_type:
          type:
          - string
          - 'null'
        config:
          description: Extractor config object (or JSON string).
        is_array:
          type:
          - boolean
          - integer
          - 'null'
        default_value:
          type:
          - string
          - 'null'
  responses:
    NotFound:
      description: The addressed resource does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing/invalid bearer token, or the Origin/Host guard rejected the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: 'Invalid input. Domain validation errors use the JSON Error shape; axum body-deserialize rejections are `text/plain` with a bare message (e.g. `Failed to deserialize the JSON body into the target type: missing field ''url''`).'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
        text/plain:
          schema:
            type: string
  parameters:
    SelectorId:
      name: selector_id
      in: path
      required: true
      description: Selector row id.
      schema:
        type: integer
        format: int64
    ExtractorId:
      name: extractor_id
      in: path
      required: true
      description: Extractor row id.
      schema:
        type: integer
        format: int64
  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"