Skip to main content
GET
Get Agent Widget Config

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

agent_id
string
required

The id of an agent. This is returned on agent creation.

Example:

"agent_3701k3ttaq12ewp8b7qv5rfyszkz"

Query Parameters

conversation_signature
string | null

An expiring token that enables a websocket conversation to start. These can be generated for an agent using the /v1/convai/conversation/get_signed_url endpoint

Response

Successful Response

agent_id
string
required
widget_config
WidgetConfigResponseModel · object
required
Example: