Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.knoxcall.com/llms.txt

Use this file to discover all available pages before exploring further.

Create Environment

POST /v1/environments
Creates a new environment.

Request Body

FieldTypeRequiredDescription
namestringYesMachine-friendly name. Must match ^[a-z0-9_-]+$ (lowercase alphanumeric, hyphens, underscores)
display_namestringNoHuman-friendly display name
descriptionstringNoDescription of the environment
colorstringNoHex color code for the UI (defaults to #6366f1)
is_defaultbooleanNoWhether this is the default environment (defaults to false)

Response

Returns the created environment object.
curl -X POST https://api.knoxcall.com/v1/environments \
  -H "Authorization: Bearer tk_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "staging",
    "display_name": "Staging",
    "description": "Pre-production testing",
    "color": "#f59e0b"
  }'

Errors

StatusTypeDescription
400validation_errorInvalid name format or missing required field
403plan_limitEnvironments not available on your plan, or environment limit reached
409conflictAn environment with this name already exists