@vellumai/assistant 0.11.4 → 0.11.5-dev.202608220019.a778cf0

package/openapi.yaml

@@ -3,7 +3,7 @@
 openapi: 3.1.0
 info:
   title: Vellum Assistant API
-  version: 0.11.4
+  version: 0.11.5
   description: Auto-generated OpenAPI specification for the Vellum Assistant runtime HTTP server.
 servers:
   - url: http://127.0.0.1:7821
@@ -4360,7 +4360,17 @@ paths:
                         setupStatus:
                           anyOf:
                             - type: string
+                              enum:
+                                - not_configured
+                                - incomplete
+                                - ready
                             - type: "null"
+                        health:
+                          type: string
+                          enum:
+                            - ok
+                            - failing
+                            - unknown
                         checkedAt:
                           anyOf:
                             - type: number
@@ -4370,7 +4380,16 @@ paths:
                         reasons:
                           type: array
                           items:
-                            type: string
+                            type: object
+                            properties:
+                              code:
+                                type: string
+                              text:
+                                type: string
+                            required:
+                              - code
+                              - text
+                            additionalProperties: false
                         localChecks:
                           type: array
                           items:
@@ -4384,6 +4403,13 @@ paths:
                                 anyOf:
                                   - type: string
                                   - type: "null"
+                              indeterminate:
+                                type: boolean
+                              kind:
+                                type: string
+                                enum:
+                                  - configuration
+                                  - operational
                             required:
                               - name
                               - passed
@@ -4401,6 +4427,13 @@ paths:
                                 anyOf:
                                   - type: string
                                   - type: "null"
+                              indeterminate:
+                                type: boolean
+                              kind:
+                                type: string
+                                enum:
+                                  - configuration
+                                  - operational
                             required:
                               - name
                               - passed
@@ -4482,7 +4515,17 @@ paths:
                         setupStatus:
                           anyOf:
                             - type: string
+                              enum:
+                                - not_configured
+                                - incomplete
+                                - ready
                             - type: "null"
+                        health:
+                          type: string
+                          enum:
+                            - ok
+                            - failing
+                            - unknown
                         checkedAt:
                           anyOf:
                             - type: number
@@ -4492,7 +4535,16 @@ paths:
                         reasons:
                           type: array
                           items:
-                            type: string
+                            type: object
+                            properties:
+                              code:
+                                type: string
+                              text:
+                                type: string
+                            required:
+                              - code
+                              - text
+                            additionalProperties: false
                         localChecks:
                           type: array
                           items:
@@ -4506,6 +4558,13 @@ paths:
                                 anyOf:
                                   - type: string
                                   - type: "null"
+                              indeterminate:
+                                type: boolean
+                              kind:
+                                type: string
+                                enum:
+                                  - configuration
+                                  - operational
                             required:
                               - name
                               - passed
@@ -4523,6 +4582,13 @@ paths:
                                 anyOf:
                                   - type: string
                                   - type: "null"
+                              indeterminate:
+                                type: boolean
+                              kind:
+                                type: string
+                                enum:
+                                  - configuration
+                                  - operational
                             required:
                               - name
                               - passed
@@ -4651,6 +4717,47 @@ paths:
                 required:
                   - recorded
                 additionalProperties: false
+  /v1/clients/web-presence:
+    post:
+      operationId: clients_webpresence_post
+      summary: Report web tab visibility and focused conversation
+      description:
+        Record the visibility and focused conversation reported by the web client identified by the
+        X-Vellum-Client-Id header.
+      tags:
+        - clients
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                visible:
+                  type: boolean
+                  description: Whether the reporting tab is currently visible.
+                focusedConversationId:
+                  anyOf:
+                    - type: string
+                    - type: "null"
+                  description: The conversation currently focused (chat composer on screen) in the tab, or null.
+              required:
+                - visible
+                - focusedConversationId
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  recorded:
+                    type: boolean
+                    description: Whether a connected client matched the reporting clientId.
+                required:
+                  - recorded
+                additionalProperties: false
   /v1/config:
     get:
       operationId: config_get
@@ -5026,6 +5133,8 @@ paths:
                 provider_connection:
                   type: string
                   minLength: 1
+                allowUnlisted:
+                  type: boolean
                 status:
                   anyOf:
                     - $ref: "#/components/schemas/ProfileStatus"
@@ -6608,6 +6717,20 @@ paths:
             predicate behind the unread count and the section index, so a client that keeps no complete conversation
             list can ask for exactly the rows its attention surfaces need. Composes with every other filter. Any value
             other than "true" is rejected. Omit to span every conversation.'
+        - name: foregroundOnly
+          in: query
+          required: false
+          schema:
+            type: string
+            enum:
+              - "true"
+          description:
+            Pass "true" to return only user-facing foreground conversations, dropping the automated background and
+            scheduled runs the standard listing admits when they are filed in a custom group (a surfaced run stays).
+            This is the same predicate the unread count and the section index apply, so a client can ask for the newest
+            conversation a user can open in one row instead of paging past runs it would skip. Composes with every other
+            filter; a foreground-only first page never has pinned rows appended to it. Any value other than "true" is
+            rejected. Omit to keep every visible row.
       responses:
         "200":
           description: Successful response
@@ -9831,7 +9954,10 @@ paths:
     post:
       operationId: credentials_delete_post
       summary: Delete a credential
-      description: Remove a secret, its metadata, and any associated OAuth connection from the vault.
+      description:
+        Remove a secret, its metadata, and any associated OAuth connection from the vault. Refused with
+        CREDENTIAL_IN_USE while an LLM provider connection resolves its auth through the credential, unless `force` is
+        set.
       tags:
         - credentials
       requestBody:
@@ -9847,6 +9973,9 @@ paths:
                 field:
                   type: string
                   description: Field name
+                force:
+                  description: Delete even when provider connections depend on the credential
+                  type: boolean
               required:
                 - service
                 - field
@@ -9862,9 +9991,15 @@ paths:
                     type: string
                   field:
                     type: string
+                  affectedConnections:
+                    type: array
+                    items:
+                      type: string
+                    description: Provider connections that depended on the deleted credential
                 required:
                   - service
                   - field
+                  - affectedConnections
                 additionalProperties: false
   /v1/credentials/inspect:
     post:
@@ -14862,6 +14997,38 @@ paths:
           description: Invalid fields, a profile that cannot serve requests, or attempt to edit a managed profile
         "404":
           description: Profile not found
+  /v1/inference/profiles/{name}/validate:
+    post:
+      operationId: inference_profiles_by_name_validate_post
+      summary: Probe a saved profile with one minimal request
+      description:
+        "Dispatch one minimal test request through the named profile's resolved model and connection, and classify
+        any failure by which object the user should fix (the profile vs its provider connection). Advisory: the probe
+        never mutates the profile. Returns a null check when there is no verdict to give (missing, disabled, managed, or
+        routing-identity profiles, or a probe timeout). The probe spends one tiny request on the profile's own key."
+      tags:
+        - inference
+      parameters:
+        - name: name
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  check:
+                    anyOf:
+                      - $ref: "#/components/schemas/InferenceProfileCheck"
+                      - type: "null"
+                required:
+                  - check
+                additionalProperties: false
   /v1/inference/provider-connections:
     get:
       operationId: inference_providerconnections_get
@@ -14943,7 +15110,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/ProviderConnection"
+                $ref: "#/components/schemas/SavedProviderConnection"
         "400":
           description: Invalid provider or auth schema
         "409":
@@ -15054,7 +15221,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/ProviderConnection"
+                $ref: "#/components/schemas/SavedProviderConnection"
         "400":
           description: Invalid auth schema, or attempt to change auth on a managed connection
         "404":
@@ -15401,6 +15568,67 @@ paths:
                   - localGatewayTarget
                   - success
                 additionalProperties: false
+  /v1/integrations/ingress/status:
+    get:
+      operationId: integrations_ingress_status_get
+      summary: Get ingress tunnel status
+      description:
+        Probe the configured public ingress URL and report whether a tunnel is serving this assistant.
+        `unconfigured` means no tunnel has ever been recorded (or the ingress is managed for this assistant, as it is
+        when platform-hosted or fronted by a Velay tunnel), `stopped` means a tunnel ran before and is not running now
+        (callback ingress is explicitly switched off, or its URL is gone), `healthy` means the URL answers and fronts
+        this assistant's web app, `unpairable` means it answers but does not serve that app, so a pairing link minted
+        against it would not open, `unreachable` means it does not answer, and `foreign` means it answers for a
+        different assistant. `lastTunnel` names the tunnel to restart, on the states where a recorded one applies to the
+        configured URL.
+      tags:
+        - config
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  state:
+                    type: string
+                    enum:
+                      - unconfigured
+                      - stopped
+                      - healthy
+                      - unpairable
+                      - unreachable
+                      - foreign
+                  publicBaseUrl:
+                    description: The probed URL. Set for healthy, unpairable, unreachable, and foreign.
+                    type: string
+                  lastTunnel:
+                    description:
+                      The tunnel to restart. Set on stopped whenever one is recorded, and on unpairable, unreachable and foreign
+                      when the recorded tunnel fronted the configured URL.
+                    type: object
+                    properties:
+                      provider:
+                        type: string
+                      publicBaseUrl:
+                        type: string
+                    required:
+                      - provider
+                      - publicBaseUrl
+                    additionalProperties: false
+                  servingAssistantName:
+                    description: Name the edge serves under. Set for foreign when it reports one.
+                    type: string
+                  detail:
+                    description: Short failure reason, free of the URL. Set for unreachable, and for unpairable when the edge gave one.
+                    type: string
+                  checkedAt:
+                    description: ISO-8601 instant the probe finished. Set whenever one ran.
+                    type: string
+                required:
+                  - state
+                additionalProperties: false
   /v1/integrations/oauth/start:
     post:
       operationId: integrations_oauth_start_post
@@ -18987,6 +19215,7 @@ paths:
                                           - tavily
                                           - keenable
                                           - firecrawl
+                                          - fastcrw
                                       resultCount:
                                         type: number
                                       durationMs:
@@ -19039,6 +19268,7 @@ paths:
                                         enum:
                                           - default
                                           - firecrawl
+                                          - fastcrw
                                       status:
                                         type: number
                                       contentType:
@@ -19496,6 +19726,7 @@ paths:
                                                   - tavily
                                                   - keenable
                                                   - firecrawl
+                                                  - fastcrw
                                               resultCount:
                                                 type: number
                                               durationMs:
@@ -19548,6 +19779,7 @@ paths:
                                                 enum:
                                                   - default
                                                   - firecrawl
+                                                  - fastcrw
                                               status:
                                                 type: number
                                               contentType:
@@ -21445,6 +21677,10 @@ paths:
                                     anyOf:
                                       - type: number
                                       - type: "null"
+                                  inactiveFileBytes:
+                                    anyOf:
+                                      - type: number
+                                      - type: "null"
                                   kernelBytes:
                                     anyOf:
                                       - type: number
@@ -21468,6 +21704,7 @@ paths:
                                 required:
                                   - anonBytes
                                   - fileBytes
+                                  - inactiveFileBytes
                                   - kernelBytes
                                   - slabReclaimableBytes
                                   - slabUnreclaimableBytes
@@ -23021,6 +23258,51 @@ paths:
                         additionalProperties: {}
                       - type: "null"
                     description: Pending secret request or null
+                  pendingQuestion:
+                    anyOf:
+                      - type: object
+                        properties:
+                          requestId:
+                            type: string
+                          entries:
+                            type: array
+                            items:
+                              type: object
+                              properties:
+                                id:
+                                  type: string
+                                question:
+                                  type: string
+                                description:
+                                  type: string
+                                options:
+                                  type: array
+                                  items:
+                                    type: object
+                                    properties:
+                                      id:
+                                        type: string
+                                      label:
+                                        type: string
+                                      description:
+                                        type: string
+                                    required:
+                                      - id
+                                      - label
+                                    additionalProperties: false
+                                freeTextPlaceholder:
+                                  type: string
+                              required:
+                                - id
+                                - question
+                                - options
+                              additionalProperties: false
+                        required:
+                          - requestId
+                          - entries
+                        additionalProperties: false
+                      - type: "null"
+                    description: Outstanding ask_question prompt or null
                   interactions:
                     type: array
                     items:
@@ -23980,10 +24262,11 @@ paths:
       summary: Disable a plugin
       description:
         Disable a plugin in this workspace by dropping a `.disabled` sentinel, mirroring the CLI's `assistant
-        plugins disable <name>`. The change is honored live at read time by every tool / injector / hook gate — no
-        restart required. Broadcasts a `sync_changed` invalidation carrying the `plugins:list` tag so other clients
-        refetch `GET /v1/plugins`. An already-disabled plugin returns 409; a user plugin with no directory returns 404
-        (default plugins are stubbed on demand via the `default-` prefix); a malformed name returns 400.
+        plugins disable <name>`. Awaits the same source reconcile enable uses so the plugin's shutdown hook runs. Tools,
+        injectors, and hook gates also honor the sentinel at read time. Broadcasts a `sync_changed` invalidation
+        carrying the `plugins:list` tag so other clients refetch `GET /v1/plugins`. An already-disabled plugin returns
+        409; a user plugin with no directory returns 404 (default plugins are stubbed on demand via the `default-`
+        prefix); a malformed name returns 400.
       tags:
         - plugins
       parameters:
@@ -25286,6 +25569,74 @@ paths:
       responses:
         "200":
           description: Successful response
+  /v1/resource-pressure/status:
+    get:
+      operationId: resourcepressure_status_get
+      summary: Get resource pressure status
+      description:
+        Return the current resource pressure status snapshot. Off-platform the guard does not run, so a disabled
+        status is returned.
+      tags:
+        - resource-pressure
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: object
+                    properties:
+                      enabled:
+                        type: boolean
+                      state:
+                        type: string
+                        enum:
+                          - disabled
+                          - ok
+                          - elevated
+                          - unknown
+                      cpuPercent:
+                        anyOf:
+                          - type: number
+                          - type: "null"
+                      memoryPercent:
+                        anyOf:
+                          - type: number
+                          - type: "null"
+                      cpuElevated:
+                        type: boolean
+                      memoryElevated:
+                        type: boolean
+                      cpuThresholdPercent:
+                        type: number
+                      memoryThresholdPercent:
+                        type: number
+                      lastCheckedAt:
+                        anyOf:
+                          - type: string
+                          - type: "null"
+                      error:
+                        anyOf:
+                          - type: string
+                          - type: "null"
+                    required:
+                      - enabled
+                      - state
+                      - cpuPercent
+                      - memoryPercent
+                      - cpuElevated
+                      - memoryElevated
+                      - cpuThresholdPercent
+                      - memoryThresholdPercent
+                      - lastCheckedAt
+                      - error
+                    additionalProperties: false
+                required:
+                  - status
+                additionalProperties: false
   /v1/retrospective/config:
     get:
       operationId: retrospective_config_get
@@ -27818,7 +28169,9 @@ paths:
     delete:
       operationId: secrets_delete
       summary: Delete a secret
-      description: Remove a secret from the credential vault by name.
+      description:
+        Remove a secret from the credential vault by name. Refused with CREDENTIAL_IN_USE while an LLM provider
+        connection resolves its auth through the credential, unless `force` is set.
       tags:
         - secrets
       requestBody:
@@ -27834,6 +28187,9 @@ paths:
                 name:
                   type: string
                   description: Name of the secret to delete
+                force:
+                  description: Delete even when provider connections depend on the credential
+                  type: boolean
               required:
                 - type
                 - name
@@ -34255,6 +34611,10 @@ components:
             - type: string
               minLength: 1
             - type: "null"
+        allowUnlisted:
+          anyOf:
+            - type: boolean
+            - type: "null"
         status:
           anyOf:
             - anyOf:
@@ -35027,6 +35387,8 @@ components:
         provider_connection:
           type: string
           minLength: 1
+        allowUnlisted:
+          type: boolean
         status:
           anyOf:
             - $ref: "#/components/schemas/ProfileStatus"
@@ -35303,6 +35665,8 @@ components:
           anyOf:
             - $ref: "#/components/schemas/ProfileConnectionAvailability"
             - type: "null"
+        config_issue:
+          $ref: "#/components/schemas/InferenceProfileConfigIssue"
       required:
         - name
         - label
@@ -35331,6 +35695,21 @@ components:
       required:
         - status
       additionalProperties: false
+    InferenceProfileConfigIssue:
+      type: object
+      properties:
+        code:
+          type: string
+          enum:
+            - model_unknown
+            - over_output_cap
+            - no_input_room
+        message:
+          type: string
+      required:
+        - code
+        - message
+      additionalProperties: false
     InferenceProfileWriteResult:
       type: object
       properties:
@@ -35371,11 +35750,36 @@ components:
           anyOf:
             - $ref: "#/components/schemas/ProfileConnectionAvailability"
             - type: "null"
+        config_issue:
+          $ref: "#/components/schemas/InferenceProfileConfigIssue"
       required:
         - name
         - entry
         - availability
       additionalProperties: false
+    InferenceProfileCheck:
+      type: object
+      properties:
+        ok:
+          type: boolean
+        blame:
+          type: string
+          enum:
+            - profile
+            - provider
+            - transient
+            - unknown
+        reason:
+          type: string
+        detail:
+          type: string
+        connection:
+          type: string
+        message:
+          type: string
+      required:
+        - ok
+      additionalProperties: false
     ProviderConnection:
       type: object
       properties:
@@ -35423,6 +35827,78 @@ components:
         - updatedAt
         - isManaged
       additionalProperties: false
+    SavedProviderConnection:
+      type: object
+      properties:
+        name:
+          type: string
+          minLength: 1
+        provider:
+          $ref: "#/components/schemas/ConnectionProvider"
+        auth:
+          $ref: "#/components/schemas/AuthOutput"
+        label:
+          anyOf:
+            - type: string
+              minLength: 1
+            - type: "null"
+        baseUrl:
+          anyOf:
+            - type: string
+              format: uri
+            - type: "null"
+        models:
+          anyOf:
+            - type: array
+              items:
+                $ref: "#/components/schemas/ConnectionModelOutput"
+            - type: "null"
+        createdAt:
+          type: integer
+          minimum: -9007199254740991
+          maximum: 9007199254740991
+        updatedAt:
+          type: integer
+          minimum: -9007199254740991
+          maximum: 9007199254740991
+        isManaged:
+          type: boolean
+        endpoint_check:
+          $ref: "#/components/schemas/EndpointCheck"
+      required:
+        - name
+        - provider
+        - auth
+        - label
+        - baseUrl
+        - models
+        - createdAt
+        - updatedAt
+        - isManaged
+      additionalProperties: false
+    EndpointCheck:
+      type: object
+      properties:
+        ok:
+          type: boolean
+        status:
+          type: integer
+          minimum: -9007199254740991
+          maximum: 9007199254740991
+        resolved_url:
+          type: string
+        error_class:
+          type: string
+          enum:
+            - http_error
+            - timeout
+            - network
+        hint:
+          type: string
+      required:
+        - ok
+        - resolved_url
+      additionalProperties: false
     ProcessEntry:
       type: object
       properties: