configuration.md

Configuration

Per-org settings (.env.<org>)

npm run setup creates one .env.<org> file per org. These files are gitignored: never commit them.

Variable	Required	Description
VAPI_PRIVATE_API_KEY	✅	The org's private API key, from Private API Keys. The older name VAPI_TOKEN is also accepted.
VAPI_BASE_URL		API base URL. Defaults to https://api.vapi.ai; EU orgs use https://api.eu.vapi.ai (npm run setup -- <org> --region eu sets it).
VAPI_CREDENTIAL_<NAME>, VAPI_PHONE_NUMBER_<NAME>		Generated by setup and pull inside a marked block: the org's credential and phone-number IDs, by name. Values you set outside the block are kept and take precedence.

A variable already set in your shell or CI environment takes precedence over the file. .env.<org>.local and .env.local are also read, after .env.<org>, and only fill in variables that are still unset.

CI and workflow settings

Set these in GitHub under Settings → Secrets and variables → Actions.

Name	Kind	Used by	Description
VAPI_PROMOTION_TOKENS	Secret	Promotion	JSON map of org name to private API key, for example {"dev":"…","prod":"…"}.
VAPI_PROMOTION_ENABLED	Variable	Promotion	true to promote automatically after changes land on main.
VAPI_CHECK_TOKENS	Secret	PR checks	JSON map of org name to private API key, for checks that run in several orgs or a CI org.
VAPI_PRIVATE_API_KEY	Secret	PR checks	A single org's key, when every check runs in one org.
VAPI_CHECKS_ENABLED	Variable	PR checks	true to run PR checks. The workflow does nothing without it.

Configuration files

File	Purpose
promotion.yml	Promotion pipelines between orgs. Start from promotion.example.yml.
vapi-checks.yml	PR checks. Start from vapi-checks.example.yml.
resources/<org>/.vapi-ignore	Platform resources this repo shouldn't manage, as glob patterns. See resources/.vapi-ignore.example and YAML conventions.

Other environment variables

Variable	Description
CI=true	Suppresses interactive warnings, such as the one pull --force prints. Set automatically by most CI systems.
VAPI_CALL_DEBUG=1	Makes npm run call log message types it would otherwise ignore.
VAPI_GITOPS_ROOT	Overrides the repository root that npm run promote and npm run check read from. Mainly for tests.