> ## Documentation Index
> Fetch the complete documentation index at: https://docs.seaotter.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Probe Hermes dashboard

> Control-plane HTTP probe of the tenant dashboard URL. Non-5xx means reachable (auth gates count as ready). When reachable, clears `dashboard_warming` so the UI can re-enable Open Hermes after secret apply / restart / credential rotate.



## OpenAPI

````yaml /openapi.json get /api/v1/agents/{agent_id}/dashboard-reachability
openapi: 3.1.0
info:
  title: SEAOTTER API
  description: >-
    SEAOTTER control plane API — managed Hermes Agent hosting. Authenticate with
    a Clerk session JWT (web) or an org-scoped API key (`Authorization: Bearer
    so_…` from POST /api/v1/api-keys). Public developer docs:
    https://docs.seaotter.dev
  version: 1.0.0
servers:
  - url: https://api.seaotter.dev
    description: Production
  - url: https://seaotter-api-bpenevambq-uc.a.run.app
    description: Production (Cloud Run URL)
  - url: http://localhost:8000
    description: Local development
security: []
tags:
  - name: agents
    description: Provision and operate Hermes agents
  - name: billing
    description: Stripe plans and subscriptions
  - name: users
    description: Current user and control-plane API keys
  - name: organizations
    description: Active organization context
  - name: audit
    description: Organization audit log (Enterprise)
  - name: health
    description: Liveness probes
paths:
  /api/v1/agents/{agent_id}/dashboard-reachability:
    get:
      tags:
        - agents
      summary: Probe Hermes dashboard
      description: >-
        Control-plane HTTP probe of the tenant dashboard URL. Non-5xx means
        reachable (auth gates count as ready). When reachable, clears
        `dashboard_warming` so the UI can re-enable Open Hermes after secret
        apply / restart / credential rotate.
      operationId: >-
        dashboard_reachability_api_v1_agents__agent_id__dashboard_reachability_get
      parameters:
        - name: agent_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardReachabilityOut'
        '401':
          description: Missing or invalid Bearer token (Clerk JWT or so_ API key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Authenticated but not permitted (role or plan gate)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    DashboardReachabilityOut:
      properties:
        reachable:
          type: boolean
          title: Reachable
          description: True when dashboard returns non-5xx
        warming:
          type: boolean
          title: Warming
          description: True when a recent restart still has the warming flag set
        http_status:
          anyOf:
            - type: integer
            - type: 'null'
          title: Http Status
          description: Last HTTP status from the probe, if any
      type: object
      required:
        - reachable
        - warming
      title: DashboardReachabilityOut
      description: Result of probing the tenant Hermes dashboard URL.
    ErrorBody:
      properties:
        detail:
          anyOf:
            - type: string
            - items: {}
              type: array
          title: Detail
          description: Human-readable error, or validation error list
          examples:
            - Agent not found
      type: object
      required:
        - detail
      title: ErrorBody
      description: Standard FastAPI / SEAOTTER error payload.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT or so_ API key
      description: >-
        Clerk session JWT for the web app (active organization required), or an
        organization-scoped SEAOTTER access key (`so_…`) from POST
        /api/v1/api-keys for programmatic / docs try-it / MCP use. The same
        `so_…` value is both `Authorization: Bearer so_…` and
        `SEAOTTER_API_KEY`.

````