# Health

> GET /api/v1/health — request parameters and responses from the Menace Voice API schema.

`GET /api/v1/health`

{/* Generated by scripts/sync_docs_api.mjs. Edit the API schema source to change the contract. */}

See [authentication](/api-reference/authentication) for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

## API contract for documentation tools

Generated from the OpenAPI schema. Do not infer a different parameter type from an example. Authentication headers are alternatives as explained in the authentication guide.

### Response 200

Successful Response

application/json: HealthResponse (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| status | string | yes |  |
| version | string | yes |  |
| backend_api_endpoint | string | yes |  |
| tunnel_url | string or null | no |  |
| deployment_mode | string | yes |  |
| auth_provider | string | yes |  |
| turn_enabled | boolean | yes |  |
| force_turn_relay | boolean | yes |  |
| signup_enabled | boolean | yes |  |
| stack_project_id | string or null | no |  |
| stack_publishable_client_key | string or null | no |  |
| stripe_billing_enabled | boolean | no | default: false |
| stripe_publishable_key | string or null | no |  |

### Response 404

Not found

## OpenAPI

````yaml api-reference/openapi.json get /api/v1/health
openapi: 3.1.0
info:
  title: Menace Voice API
  description: API for Menace Voice agents
  version: 1.0.0
servers:
  - url: https://voice.menaceui.com
    description: Production
  - url: http://localhost:8000
    description: Local development
paths:
  /api/v1/health:
    get:
      tags:
        - main
      summary: Health
      operationId: health_api_v1_health_get
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HealthResponse"
        "404":
          description: Not found
components:
  schemas:
    HealthResponse:
      properties:
        status:
          type: string
          title: Status
        version:
          type: string
          title: Version
        backend_api_endpoint:
          type: string
          title: Backend Api Endpoint
        tunnel_url:
          anyOf:
            - type: string
            - type: "null"
          title: Tunnel Url
        deployment_mode:
          type: string
          title: Deployment Mode
        auth_provider:
          type: string
          title: Auth Provider
        turn_enabled:
          type: boolean
          title: Turn Enabled
        force_turn_relay:
          type: boolean
          title: Force Turn Relay
        signup_enabled:
          type: boolean
          title: Signup Enabled
        stack_project_id:
          anyOf:
            - type: string
            - type: "null"
          title: Stack Project Id
        stack_publishable_client_key:
          anyOf:
            - type: string
            - type: "null"
          title: Stack Publishable Client Key
        stripe_billing_enabled:
          type: boolean
          title: Stripe Billing Enabled
          default: false
        stripe_publishable_key:
          anyOf:
            - type: string
            - type: "null"
          title: Stripe Publishable Key
      type: object
      required:
        - status
        - version
        - backend_api_endpoint
        - deployment_mode
        - auth_provider
        - turn_enabled
        - force_turn_relay
        - signup_enabled
      title: HealthResponse
````