List Custom Components

curl --request GET \
  --url https://api.bland.ai/v1/widget/custom_components \
  --header 'authorization: <authorization>'

import requests

url = "https://api.bland.ai/v1/widget/custom_components"

headers = {"authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {authorization: '<authorization>'}};

fetch('https://api.bland.ai/v1/widget/custom_components', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bland.ai/v1/widget/custom_components",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bland.ai/v1/widget/custom_components"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bland.ai/v1/widget/custom_components")
  .header("authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bland.ai/v1/widget/custom_components")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "created_at": "2025-10-02T21:45:27.633Z",
      "updated_at": "2025-10-02T21:45:27.633Z",
      "id": "70b56282-8db5-4e26-aad9-098c099fb1db",
      "org_id": "99a0d526-6910-4f31-92b8-72834d0827fb",
      "widget_id": "7d1a8c0d-5346-4f96-9f5c-d888e273eaf0",
      "pathway_id": "05f4b269-e79a-4825-b4cd-7778f782bfad",
      "pathway_node": "1",
      "width": "100%",
      "height": "300px",
      "variables": [
        "firstName"
      ],
      "iframe_url": "https://widget-custom-components.vercel.app"
    }
  ],
  "errors": null
}

GET

widget

custom_components

List Custom Components

curl --request GET \
  --url https://api.bland.ai/v1/widget/custom_components \
  --header 'authorization: <authorization>'

import requests

url = "https://api.bland.ai/v1/widget/custom_components"

headers = {"authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {authorization: '<authorization>'}};

fetch('https://api.bland.ai/v1/widget/custom_components', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bland.ai/v1/widget/custom_components",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bland.ai/v1/widget/custom_components"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bland.ai/v1/widget/custom_components")
  .header("authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bland.ai/v1/widget/custom_components")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "created_at": "2025-10-02T21:45:27.633Z",
      "updated_at": "2025-10-02T21:45:27.633Z",
      "id": "70b56282-8db5-4e26-aad9-098c099fb1db",
      "org_id": "99a0d526-6910-4f31-92b8-72834d0827fb",
      "widget_id": "7d1a8c0d-5346-4f96-9f5c-d888e273eaf0",
      "pathway_id": "05f4b269-e79a-4825-b4cd-7778f782bfad",
      "pathway_node": "1",
      "width": "100%",
      "height": "300px",
      "variables": [
        "firstName"
      ],
      "iframe_url": "https://widget-custom-components.vercel.app"
    }
  ],
  "errors": null
}

Headers

authorization

string

required

Your API key for authentication.

Response

status

number

HTTP status code (200 for success).

data

object

id (string): Custom component UUID
org_id (string): Organization UUID
widget_id (string): Widget identifier UUID
pathway_id (string): Associated pathway UUID
pathway_node (string): Pathway node ID to display the custom component on
width (string): Widget width dimension
height (string): Widget height dimension
variables (string[]): Array of variable names to pass into the custom component iframe URL as query params
iframe_url (string): URL for the iframe source
created_at (string): ISO timestamp
updated_at (string): ISO timestamp

errors

null

Always null on successful response.

{
  "data": [
    {
      "created_at": "2025-10-02T21:45:27.633Z",
      "updated_at": "2025-10-02T21:45:27.633Z",
      "id": "70b56282-8db5-4e26-aad9-098c099fb1db",
      "org_id": "99a0d526-6910-4f31-92b8-72834d0827fb",
      "widget_id": "7d1a8c0d-5346-4f96-9f5c-d888e273eaf0",
      "pathway_id": "05f4b269-e79a-4825-b4cd-7778f782bfad",
      "pathway_node": "1",
      "width": "100%",
      "height": "300px",
      "variables": [
        "firstName"
      ],
      "iframe_url": "https://widget-custom-components.vercel.app"
    }
  ],
  "errors": null
}

Docs for agents: llms.txt

Send Live Agent Message Create Custom Component

⌘I

​Headers

​Response

Headers

Response