Health

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

1 min read

get/api/v1/health

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/health

Response

{
  "status": "<string>",
  "version": "<string>",
  "backend_api_endpoint": "<string>",
  "tunnel_url": "<string>",
  "deployment_mode": "<string>",
  "auth_provider": "<string>",
  "turn_enabled": true,
  "force_turn_relay": true,
  "signup_enabled": true,
  "stack_project_id": "<string>",
  "stack_publishable_client_key": "<string>",
  "stripe_billing_enabled": false,
  "stripe_publishable_key": "<string>"
}

get/api/v1/health

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Responses

application/json

Successful Response

statusstringrequired#

versionstringrequired#

backend_api_endpointstringrequired#

tunnel_urlstring · null#

Show child attributes

Any of

deployment_modestringrequired#

auth_providerstringrequired#

turn_enabledbooleanrequired#

force_turn_relaybooleanrequired#

signup_enabledbooleanrequired#

stack_project_idstring · null#

Show child attributes

Any of

stack_publishable_client_keystring · null#

Show child attributes

Any of

stripe_billing_enabledboolean#

Default: false

stripe_publishable_keystring · null#

Show child attributes

Any of

Delete Folder Active Calls