Client

​

Constructor

new Client(options: ClientConfig = {}): Client

Configuration options for the HoneyHive Control Plane client. They extend the options from openapi-fetch, but replace ‘baseUrl’ with ‘controlPlaneUrl’ so the name is unambiguous (the data plane SDK uses ‘dataPlaneUrl’).

​

Properties

​

apiKey?

optional apiKey?: string

A fine-grained control-plane API key (hh_fgcp_…), the only credential the control plane’s API accepts. Defaults to the HH_CONTROL_PLANE_API_KEY environment variable. The value is trimmed, and one that is not a well-formed fine-grained key throws at construction, naming the option or variable it came from. An empty value counts as no key.

---

​

controlPlaneUrl?

optional controlPlaneUrl?: string

---

​

headers?

optional headers?: Record<string, string>

---

​

middleware?

optional middleware?: Middleware[]

---

​

verbose?

optional verbose?: boolean

When true, logs the resolved control plane URL, a masked API key, and the SDK package + version via console.error on client construction (stderr in Node, devtools in the browser). Useful for confirming which environment, credential, and SDK build the client is configured with. Defaults to true when the HH_VERBOSE environment variable is set to 'true' (case-insensitive).

---