@vellumai/assistant 0.7.1 → 0.7.2

package/openapi.yaml

@@ -3,7 +3,7 @@
 openapi: 3.0.0
 info:
   title: Vellum Assistant API
-  version: 0.7.1
+  version: 0.7.2
   description: Auto-generated OpenAPI specification for the Vellum Assistant runtime HTTP server.
 servers:
   - url: http://127.0.0.1:7821
@@ -3206,6 +3206,68 @@ paths:
                 - keepId
                 - mergeId
               additionalProperties: false
+  /v1/contacts/prompt:
+    post:
+      operationId: contacts_prompt_post
+      summary: Prompt user to register a contact channel
+      description:
+        Broadcasts a contact_request to connected clients, waits for the user to submit an address via the gateway.
+        The gateway owns the contact write and notifies the daemon via resolve_contact_prompt IPC.
+      tags:
+        - contacts
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  ok:
+                    type: boolean
+                  error:
+                    type: string
+                  contactId:
+                    type: string
+                  channelId:
+                    type: string
+                  channelType:
+                    type: string
+                  address:
+                    type: string
+                required:
+                  - ok
+                additionalProperties: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                channel:
+                  description: Suggested channel type hint (e.g. phone, email, telegram). Free text — not enforced.
+                  type: string
+                placeholder:
+                  description: Placeholder text for the address input field.
+                  type: string
+                label:
+                  description: Display label shown in the prompt UI.
+                  type: string
+                description:
+                  description: Longer description for the prompt UI.
+                  type: string
+                role:
+                  default: unknown
+                  description: Intended role of the contact being registered.
+                  type: string
+                  enum:
+                    - guardian
+                    - trusted-contact
+                    - unknown
+              required:
+                - role
+              additionalProperties: false
   /v1/contacts/search:
     post:
       operationId: contacts_search_post
@@ -4520,6 +4582,22 @@ paths:
           required: true
           schema:
             type: string
+  /v1/documents/{id}/pdf:
+    get:
+      operationId: documents_by_id_pdf_get
+      summary: Export a document as PDF
+      description: Render a document to PDF and return the binary content.
+      tags:
+        - documents
+      responses:
+        "200":
+          description: Successful response
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
   /v1/events:
     get:
       operationId: events_get
@@ -4647,6 +4725,35 @@ paths:
                   - success
                   - ran
                 additionalProperties: false
+  /v1/gateway/logs/tail:
+    get:
+      operationId: gateway_logs_tail_get
+      summary: Tail gateway log entries
+      description: Return the last N structured log entries from the gateway log files.
+      tags:
+        - gateway-logs
+      responses:
+        "200":
+          description: Successful response
+      parameters:
+        - name: n
+          in: query
+          required: false
+          schema:
+            type: string
+          description: "Number of lines to return (1–1000, default: 10)"
+        - name: level
+          in: query
+          required: false
+          schema:
+            type: string
+          description: "Minimum pino level name (default: info)"
+        - name: module
+          in: query
+          required: false
+          schema:
+            type: string
+          description: Filter to exact pino module name
   /v1/groups:
     get:
       operationId: groups_get
@@ -5175,6 +5282,14 @@ paths:
                     anyOf:
                       - type: number
                       - type: "null"
+                  cronExpression:
+                    anyOf:
+                      - type: string
+                      - type: "null"
+                  timezone:
+                    anyOf:
+                      - type: string
+                      - type: "null"
                   nextRunAt:
                     anyOf:
                       - type: number
@@ -5190,6 +5305,8 @@ paths:
                   - intervalMs
                   - activeHoursStart
                   - activeHoursEnd
+                  - cronExpression
+                  - timezone
                   - nextRunAt
                   - lastRunAt
                   - success
@@ -5220,6 +5337,14 @@ paths:
                     anyOf:
                       - type: number
                       - type: "null"
+                  cronExpression:
+                    anyOf:
+                      - type: string
+                      - type: "null"
+                  timezone:
+                    anyOf:
+                      - type: string
+                      - type: "null"
                   nextRunAt:
                     anyOf:
                       - type: number
@@ -5235,6 +5360,8 @@ paths:
                   - intervalMs
                   - activeHoursStart
                   - activeHoursEnd
+                  - cronExpression
+                  - timezone
                   - nextRunAt
                   - lastRunAt
                   - success
@@ -5247,22 +5374,31 @@ paths:
               type: object
               properties:
                 enabled:
-                  type: boolean
                   description: Enable or disable heartbeat
+                  type: boolean
                 intervalMs:
-                  type: number
                   description: Heartbeat interval in ms
-                activeHoursStart:
                   type: number
+                activeHoursStart:
                   description: Active hours start (0–23)
+                  anyOf:
+                    - type: number
+                    - type: "null"
                 activeHoursEnd:
-                  type: number
                   description: Active hours end (0–23)
-              required:
-                - enabled
-                - intervalMs
-                - activeHoursStart
-                - activeHoursEnd
+                  anyOf:
+                    - type: number
+                    - type: "null"
+                cronExpression:
+                  description: Cron expression for heartbeat timing, or null for fixed interval
+                  anyOf:
+                    - type: string
+                    - type: "null"
+                timezone:
+                  description: Timezone for cron evaluation
+                  anyOf:
+                    - type: string
+                    - type: "null"
               additionalProperties: false
   /v1/heartbeat/run-now:
     post:
@@ -5305,7 +5441,53 @@ paths:
                 properties:
                   runs:
                     type: array
-                    items: {}
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                        scheduledFor:
+                          type: number
+                        startedAt:
+                          anyOf:
+                            - type: number
+                            - type: "null"
+                        finishedAt:
+                          anyOf:
+                            - type: number
+                            - type: "null"
+                        durationMs:
+                          anyOf:
+                            - type: number
+                            - type: "null"
+                        status:
+                          type: string
+                        skipReason:
+                          anyOf:
+                            - type: string
+                            - type: "null"
+                        error:
+                          anyOf:
+                            - type: string
+                            - type: "null"
+                        conversationId:
+                          anyOf:
+                            - type: string
+                            - type: "null"
+                        createdAt:
+                          type: number
+                      required:
+                        - id
+                        - scheduledFor
+                        - startedAt
+                        - finishedAt
+                        - durationMs
+                        - status
+                        - skipReason
+                        - error
+                        - conversationId
+                        - createdAt
+                      additionalProperties: false
                     description: Heartbeat run records
                 required:
                   - runs
@@ -5811,6 +5993,73 @@ paths:
                 additionalProperties: false
         "500":
           description: Failed to compute relationship state
+  /v1/host-app-control-result:
+    post:
+      operationId: hostappcontrolresult_post
+      summary: Submit host app-control result
+      description:
+        Resolve a pending host app-control request by requestId. Returns 200 even when no pending interaction
+        matches (late delivery is tolerated).
+      tags:
+        - host
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  accepted:
+                    type: boolean
+                required:
+                  - accepted
+                additionalProperties: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                requestId:
+                  type: string
+                  description: Pending app-control request ID
+                state:
+                  type: string
+                  enum:
+                    - running
+                    - missing
+                    - minimized
+                  description: Lifecycle state of the targeted application
+                pngBase64:
+                  type: string
+                  description: Base64 PNG screenshot of the targeted app window
+                windowBounds:
+                  type: object
+                  properties:
+                    x:
+                      type: number
+                    y:
+                      type: number
+                    width:
+                      type: number
+                    height:
+                      type: number
+                  required:
+                    - x
+                    - y
+                    - width
+                    - height
+                  additionalProperties: false
+                executionResult:
+                  type: string
+                executionError:
+                  type: string
+              required:
+                - requestId
+                - state
+              additionalProperties: false
   /v1/host-bash-result:
     post:
       operationId: hostbashresult_post
@@ -5831,6 +6080,14 @@ paths:
                 required:
                   - accepted
                 additionalProperties: false
+        "400":
+          description: x-vellum-client-id header is missing for a targeted host bash request.
+        "403":
+          description: Submitting client does not match the targeted client for this request.
+        "404":
+          description: No pending interaction found for the given requestId.
+        "409":
+          description: Pending interaction exists but is of a different kind (e.g. host_file, host_cu).
       requestBody:
         required: true
         content:
@@ -5852,6 +6109,44 @@ paths:
               required:
                 - requestId
               additionalProperties: false
+  /v1/host-browser-event:
+    post:
+      operationId: hostbrowserevent_post
+      summary: Forward a CDP event from the browser extension
+      description: Publishes a chrome.debugger.onEvent firing into the runtime-side browser-session event bus.
+      tags:
+        - host
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  accepted:
+                    type: boolean
+                required:
+                  - accepted
+                additionalProperties: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                method:
+                  type: string
+                  description: CDP event method name
+                params:
+                  description: CDP event parameters
+                cdpSessionId:
+                  description: CDP session ID (if target-scoped)
+                  type: string
+              required:
+                - method
+              additionalProperties: false
   /v1/host-browser-result:
     post:
       operationId: hostbrowserresult_post
@@ -5889,6 +6184,40 @@ paths:
               required:
                 - requestId
               additionalProperties: false
+  /v1/host-browser-session-invalidated:
+    post:
+      operationId: hostbrowsersessioninvalidated_post
+      summary: Notify runtime that a CDP session was invalidated
+      description: Marks the target as invalidated in the runtime-side browser session registry.
+      tags:
+        - host
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  accepted:
+                    type: boolean
+                required:
+                  - accepted
+                additionalProperties: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                targetId:
+                  description: CDP target that was detached
+                  type: string
+                reason:
+                  description: Detach reason
+                  type: string
+              additionalProperties: false
   /v1/host-cu-result:
     post:
       operationId: hostcuresult_post
@@ -5909,6 +6238,14 @@ paths:
                 required:
                   - accepted
                 additionalProperties: false
+        "400":
+          description: x-vellum-client-id header is missing for a targeted host CU request.
+        "403":
+          description: Submitting client does not match the targeted client for this request.
+        "404":
+          description: No pending interaction found for the given requestId, or the conversation/proxy no longer exists.
+        "409":
+          description: Pending interaction exists but is of a different kind (e.g. host_bash, host_file).
       requestBody:
         required: true
         content:
@@ -5967,6 +6304,14 @@ paths:
                 required:
                   - accepted
                 additionalProperties: false
+        "400":
+          description: x-vellum-client-id header is missing for a targeted host file request.
+        "403":
+          description: Submitting client does not match the targeted client for this request.
+        "404":
+          description: No pending interaction found for the given requestId.
+        "409":
+          description: Pending interaction exists but is of a different kind (e.g. host_bash, host_cu).
       requestBody:
         required: true
         content:
@@ -6009,6 +6354,10 @@ paths:
                 required:
                   - accepted
                 additionalProperties: false
+        "400":
+          description: x-vellum-client-id header is missing for a targeted host transfer request.
+        "403":
+          description: Submitting client does not match the targeted client for this transfer.
       requestBody:
         required: true
         content:
@@ -6070,7 +6419,9 @@ paths:
     get:
       operationId: identity_intro_get
       summary: Get identity intro text
-      description: Returns the cached identity intro string, preferring SOUL.md over LLM-generated cache.
+      description:
+        Returns a deterministic greeting derived from the assistant name in IDENTITY.md, falling back to
+        LLM-generated cache.
       tags:
         - identity
       responses:
@@ -6355,6 +6706,56 @@ paths:
           required: true
           schema:
             type: string
+  /v1/internal/mcp/auth/start:
+    post:
+      operationId: internal_mcp_auth_start_post
+      summary: Start MCP OAuth flow
+      description: Starts a daemon-owned MCP OAuth flow and returns the authorization URL for the CLI to open in the browser.
+      tags:
+        - internal
+      responses:
+        "200":
+          description: Successful response
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                serverId:
+                  type: string
+              required:
+                - serverId
+              additionalProperties: false
+  /v1/internal/mcp/auth/status/{serverId}:
+    get:
+      operationId: internal_mcp_auth_status_by_serverId_get
+      summary: Poll MCP OAuth flow status
+      description: Returns the current status of an in-flight MCP OAuth flow (pending/complete/error).
+      tags:
+        - internal
+      responses:
+        "200":
+          description: Successful response
+        "404":
+          description: No active OAuth flow for the given serverId
+      parameters:
+        - name: serverId
+          in: path
+          required: true
+          schema:
+            type: string
+  /v1/internal/mcp/reload:
+    post:
+      operationId: internal_mcp_reload_post
+      summary: Trigger MCP server reload
+      description: Kicks off reloadMcpServers() async on the daemon. Returns immediately.
+      tags:
+        - internal
+      responses:
+        "200":
+          description: Successful response
   /v1/internal/oauth/callback:
     post:
       operationId: internal_oauth_callback_post
@@ -6717,6 +7118,124 @@ paths:
               required:
                 - op
               additionalProperties: false
+  /v1/memory/v2/concept-page:
+    post:
+      operationId: memory_v2_conceptpage_post
+      summary: Read a single memory v2 concept page
+      description:
+        Returns the rendered (frontmatter + body) markdown for a slug. 404 when the slug has no on-disk page — the
+        activation log inspector uses this to show what got injected.
+      tags:
+        - memory
+      responses:
+        "200":
+          description: Successful response
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                slug:
+                  type: string
+                  minLength: 1
+              required:
+                - slug
+              additionalProperties: false
+  /v1/memory/v2/explain-similarity:
+    post:
+      operationId: memory_v2_explainsimilarity_post
+      summary: Diagnose dense vs sparse similarity score distributions
+      description:
+        Read-only diagnostic. Embeds the supplied text(s), runs hybrid dense + sparse queries against the
+        concept-page collection, and returns per-slug raw dense, raw sparse, normalized sparse, and fused scores plus
+        per-channel summary stats. Used to investigate score-compression at the head of the activation distribution.
+      tags:
+        - memory
+      responses:
+        "200":
+          description: Successful response
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                userText:
+                  type: string
+                  minLength: 1
+                assistantText:
+                  type: string
+                nowText:
+                  type: string
+                top:
+                  default: 25
+                  type: integer
+                  minimum: 1
+                  maximum: 9007199254740991
+              required:
+                - userText
+                - top
+              additionalProperties: false
+  /v1/memory/v2/fit-anisotropy:
+    post:
+      operationId: memory_v2_fitanisotropy_post
+      summary: Fit the embedding anisotropy correction for memory v2
+      description:
+        Samples stored dense vectors from the concept-page Qdrant collection, fits a corpus mean + top-k principal
+        components (Mu & Viswanath 'all-but-the-top'), and persists the calibration so subsequent embeds and queries
+        apply the correction. Run `assistant memory v2 reembed` after fitting so stored vectors are written under the
+        new calibration — until then, queries (corrected) and stored vectors (uncorrected) live in different spaces.
+      tags:
+        - memory
+      responses:
+        "200":
+          description: Successful response
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                k:
+                  default: 1
+                  type: integer
+                  minimum: 1
+                  maximum: 16
+                sample:
+                  default: 5000
+                  type: integer
+                  minimum: 1
+                  maximum: 100000
+              required:
+                - k
+                - sample
+              additionalProperties: false
+  /v1/memory/v2/rebuild-corpus-stats:
+    post:
+      operationId: memory_v2_rebuildcorpusstats_post
+      summary: Rebuild the BM25 corpus statistics for memory v2
+      description:
+        Walks every concept page on disk, recomputes the document-frequency table and average document length used
+        by the BM25 sparse channel, and atomically swaps the in-memory stats. Run after bulk content imports or to
+        recover from a rebuild that errored at startup. Does not reembed individual page sparse vectors — pair with
+        `assistant memory v2 reembed` when document-side weights need refreshing.
+      tags:
+        - memory
+      responses:
+        "200":
+          description: Successful response
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties: {}
+              additionalProperties: false
   /v1/memory/v2/reembed-skills:
     post:
       operationId: memory_v2_reembedskills_post
@@ -6874,6 +7393,13 @@ paths:
                 properties:
                   messageId:
                     type: string
+                  conversationKind:
+                    type: string
+                    enum:
+                      - user
+                      - background
+                      - background_memory_consolidation
+                      - scheduled
                   logs:
                     type: array
                     items: {}
@@ -6891,6 +7417,7 @@ paths:
                       - type: "null"
                 required:
                   - messageId
+                  - conversationKind
                   - logs
                   - memoryRecall
                   - memoryV2Activation
@@ -8243,6 +8770,16 @@ paths:
               required:
                 - conversationId
               additionalProperties: false
+  /v1/resolve_contact_prompt:
+    post:
+      operationId: resolve_contact_prompt_post
+      summary: "Gateway callback: resolve a pending contact prompt"
+      description: Called by the gateway after it writes the contact and channel. Unblocks the waiting contacts/prompt IPC call.
+      tags:
+        - contacts
+      responses:
+        "200":
+          description: Successful response
   /v1/schedules:
     get:
       operationId: schedules_get
@@ -8357,6 +8894,12 @@ paths:
                   type: boolean
                 reuseConversation:
                   type: boolean
+                maxRetries:
+                  type: number
+                  description: Maximum retry attempts
+                retryBackoffMs:
+                  type: number
+                  description: Retry backoff in milliseconds
               required:
                 - name
                 - expression
@@ -8367,6 +8910,8 @@ paths:
                 - routingIntent
                 - quiet
                 - reuseConversation
+                - maxRetries
+                - retryBackoffMs
               additionalProperties: false
   /v1/schedules/{id}/cancel:
     post:
@@ -10855,6 +11400,10 @@ paths:
       responses:
         "200":
           description: Successful response
+        "400":
+          description: x-vellum-client-id header is missing for a targeted transfer.
+        "403":
+          description: Submitting client does not match the targeted client for this transfer.
       parameters:
         - name: transferId
           in: path
@@ -10870,6 +11419,10 @@ paths:
       responses:
         "200":
           description: Successful response
+        "400":
+          description: x-vellum-client-id header is missing for a targeted transfer.
+        "403":
+          description: Submitting client does not match the targeted client for this transfer.
       parameters:
         - name: transferId
           in: path