Skip to main content
Configuration options for the HoneyHive API client. They extend the options from openapi-fetch, but replace ‘baseUrl’ with ‘dataPlaneUrl’ so the name is unambiguous now that the SDK can also talk to the HoneyHive control plane.

​
Extends

  • Omit<ClientOptions, "baseUrl" | "headers">

​
Properties

​
apiKey?

optional apiKey?: string

​
dataPlaneUrl?

optional dataPlaneUrl?: string

​
headers?

optional headers?: Record<string, string>

​
middleware?

optional middleware?: Middleware[]

​
serverUrl?

optional serverUrl?: string

​
Deprecated

Use dataPlaneUrl instead. The old name will be removed in the next major version. Setting this option still works but logs a deprecation warning to stderr on client construction.

​
verbose?

optional verbose?: boolean
When true, logs the resolved API 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).