Skip to main content
GET
/
v1
/
widget
/
{id}
Get Widget by ID
curl --request GET \
  --url https://api.bland.ai/v1/widget/{id} \
  --header 'authorization: <authorization>'
{
  "status": 200,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "pathway_id": "a0f0d4ed-f5f5-4f16-b3f9-22166594d7a7",
    "agent_id": "46f37229-7d12-44be-b343-6e68274cfbea",
    "allowed_domains": ["example.com", "subdomain.example.com"],
    "messages_per_minute": 10,
    "config": {
      "theme": "light",
      "position": "bottom-right",
      "greeting": "Hello! How can I help you today?"
    },
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T12:45:00Z"
  },
  "errors": null
}

​
Headers

​
authorization
string
required
Your API key for authentication.

​
Path Parameters

​
id
string
required
UUID of the widget to retrieve.

​
Response

​
status
number
HTTP status code (200 for success).
​
data
object
The widget object containing:
  • id (string): Widget UUID
  • pathway_id (string | null): Associated pathway UUID
  • agent_id (string | null): Associated agent UUID or null
  • agent_prompt (string | null): Agent prompt used instead of pathway
  • allowed_domains (string[]): Array of allowed domains
  • messages_per_minute (number): Rate limit for messages
  • config (object): Widget configuration object
  • created_at (string): ISO timestamp
  • updated_at (string): ISO timestamp
​
errors
null
Always null on successful response.
{
  "status": 200,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "pathway_id": "a0f0d4ed-f5f5-4f16-b3f9-22166594d7a7",
    "agent_id": "46f37229-7d12-44be-b343-6e68274cfbea",
    "allowed_domains": ["example.com", "subdomain.example.com"],
    "messages_per_minute": 10,
    "config": {
      "theme": "light",
      "position": "bottom-right",
      "greeting": "Hello! How can I help you today?"
    },
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T12:45:00Z"
  },
  "errors": null
}
Docs for agents: llms.txt