Environment Variables - HoneyHive AI Docs

The SDK reads the following environment variables. All are optional, and each can be overridden by the equivalent Client constructor option, which takes precedence over its environment variable.

Configuration

Variable	Description	Default	Override option
`HH_PROJECT_API_KEY`	Classic project API key for operations that still require it, including creating and updating datasets, event reads, and experiment runs. Also used for ingestion when `HH_INGESTION_API_KEY` is unset.	None	`projectApiKey`
`HH_INGESTION_API_KEY`	Ingestion API key (`hh_ingst_`) for the methods that create sessions and create or update events. When unset, those methods use the project key. Any value that is not an ingestion key throws on construction.	None	`ingestionApiKey`
`HH_DATA_PLANE_API_KEY`	Data plane fine-grained API key (`hh_fgdp_`) for supported project-scoped methods. Pass `project_id` in the request. A wrong key type or incomplete value throws on construction.	None	`dataPlaneApiKey`
`HH_DATA_PLANE_URL`	Base URL for the Data Plane API.	`https://api.dp1.us.honeyhive.ai`	`dataPlaneUrl`
`HH_VERBOSE`	Set to `"true"` (case-insensitive) to log the resolved data plane URL, its masked API keys, and the SDK version on construction.	`false`	`verbose`

An empty string is treated the same as unset. A client can be constructed with no key; without custom authentication, each method checks for the credential it needs before sending a request. A project key cannot substitute for a data plane key. See Authorization.

Deprecated aliases

These names are still accepted but will be removed in the next major version. Using either logs a deprecation warning to stderr on client construction.

Variable	Replacement
`HH_API_KEY`	`HH_PROJECT_API_KEY`
`HH_API_URL`	`HH_DATA_PLANE_URL`

Resolution runs new option → deprecated option → new environment variable → deprecated environment variable, so a deprecated name only takes effect when no current one resolved.

There is no HONEYHIVE_* prefix in the TypeScript SDK. Unlike the Python SDK, only the HH_* names above are recognized.