> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Client

> HoneyHive TypeScript Control Plane SDK client class reference

## 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 in practice. Sent as a bearer token as-is; the
control plane is what rejects a key it doesn't accept. Defaults to the
`HH_CONTROL_PLANE_API_KEY` environment variable.

***

### 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).

***