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

# Health

> Liveness and readiness probe with queue stats and matrix-circuit state



## OpenAPI

````yaml vrp-v3 GET /v3/health
openapi: 3.1.0
info:
  title: Solvice Routing Solver
  description: >-
    Optimizes vehicle routes to minimize distance, time, or fleet size while
    respecting capacity, time windows, skills, and custom constraints.


    **Authentication:** send your Solvice API key (or Auth0 JWT) in the
    `Authorization` header. In production, requests are routed through the
    Solvice gateway at `api.solvice.io`.
  contact:
    name: Solvice
    url: https://www.solvice.io
  license:
    name: Proprietary
  version: 3.0.0
servers:
  - url: https://api.solvice.io
    description: Production — Solvice API gateway
security:
  - apiKey: []
tags:
  - name: Routing
    description: Vehicle routing optimization
  - name: Operations
    description: Health and diagnostics
paths:
  /v3/health:
    get:
      tags:
        - Operations
      summary: Liveness and readiness probe
      operationId: health_handler
      responses:
        '200':
          description: Healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '503':
          description: Overloaded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
components:
  schemas:
    HealthResponse:
      type: object
      description: Health check response from `GET /health`.
      required:
        - status
        - solver_active
        - solver_waiting
        - maps_circuit
      properties:
        maps_circuit:
          type: string
          description: >-
            Circuit breaker state: `"closed"`, `"open"`, `"half_open"`, or
            `"n/a"`.
          example: closed
        solver_active:
          type: integer
          description: Number of solver permits currently in use.
          example: 0
          minimum: 0
        solver_waiting:
          type: integer
          description: Number of requests waiting for a solver permit.
          example: 0
          minimum: 0
        status:
          type: string
          description: >-
            `"ok"` when healthy, `"overloaded"` when the solver queue is at
            capacity.
          example: ok
      example:
        maps_circuit: closed
        solver_active: 0
        solver_waiting: 0
        status: ok
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization

````