Get Agent Widget Config

Return the embed-widget appearance config for an agent. Works unauthenticated for public agents; the body is cosmetic only.

Response headers

X-Request-IDstring

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an X-Request-ID request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an `X-Request-ID` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope.

1	{
2	"version": 1,
3	"style": "pill",
4	"theme": "dark",
5	"avatar": {
6	"type": "orb",
7	"image_url": "example",
8	"orb_color_1": "example",
9	"orb_color_2": "example"
10	},
11	"text": {
12	"start_call": "example",
13	"end_call": "example",
14	"listening": "example",
15	"thinking": "example",
16	"speaking": "example"
17	},
18	"terms": {
19	"enabled": true,
20	"content": "example"
21	},
22	"transcript": {
23	"enabled": true
24	}
25	}

Authentication

Path parameters

Headers

Response headers

Response

Errors

$	curl https://api.speechify.ai/v1/agents/agent_01k7m6etzwf057j6w0zmdsgppr/widget-config \
>	-H "Authorization: Bearer <token>"