Rate this page:

AgentsClientParameters

Cartesia.AgentsClient parameters. Can be passed as arguments to the Cartesia.createAgentsClient method.

Props

agentId: string

The unique identifier for the Cartesia Voice Agent.

apiKey: string

The API key for the Cartesia. Used to generate access token.

cartesiaVersion: string

Cartesia API version.

onWebSocketClose: (event: WebSocketEvents.CLOSE) => void | undefined

Optional. A callback function that is called when the WebSocket connection is closed.

statistics: false | undefined | true

Optional. Enables statistics functionality.

trace: false | undefined | true

Optional. Whether to enable the tracing functionality. If tracing is enabled, an URL to the trace file appears in the websocket.created message. The file contains all sent and received WebSocket messages in the plain text format. The file is uploaded to the S3 storage.

Note: Enable this only for diagnostic purposes. You can provide the trace file to our support team to help investigating issues.