Introduction
Agent API
Agent Tool API
Widget Settings API
Phone Number & Telephony API
- GETList Available Numbers
- POSTBuy Phone Number
- DELRelease Phone Number
- GETList Purchased Numbers
- POSTImport Phone Number
- GETList Imported Numbers
- GETGet Imported Number
- PUTUpdate Imported Number
- DELDelete Imported Number
- GETList Twilio Owned Numbers
- POSTAdd Twilio Number
- POSTCreate Telephony Type
- GETGet Selected Telephony
Campaign API
Contact API
Appointment API
Cal.com Integration API
RAG Knowledge Base API
Webhooks
Health API
curl https://api.ravan.ai/api/v1/widget-settings/ \
-H "X-Api-Key: YOUR_API_KEY"
{
"success": true,
"message": "Widget settings fetched successfully",
"data": [
{
"id": "019d1fdb-6701-762d-97bd-93fc72606d7c",
"botName": "Ava Support",
"botAutoStart": false,
"botPosition": "bottom-right",
"customFormFields": null,
"theme": null,
"language": "en",
"isActive": true,
"createdAt": "2026-03-20T10:30:00Z",
"updatedAt": "2026-03-20T14:15:00Z"
}
]
}
Widget Settings API
List Widget Settings
Retrieve all widget configurations in your organization. Each widget settings object defines the appearance and behavior of an embeddable voice chat widget.
GET
/
api
/
v1
/
widget-settings
curl https://api.ravan.ai/api/v1/widget-settings/ \
-H "X-Api-Key: YOUR_API_KEY"
{
"success": true,
"message": "Widget settings fetched successfully",
"data": [
{
"id": "019d1fdb-6701-762d-97bd-93fc72606d7c",
"botName": "Ava Support",
"botAutoStart": false,
"botPosition": "bottom-right",
"customFormFields": null,
"theme": null,
"language": "en",
"isActive": true,
"createdAt": "2026-03-20T10:30:00Z",
"updatedAt": "2026-03-20T14:15:00Z"
}
]
}
Authorizations
Your Agni API key. Find it in your support@ravan.ai under Settings → API Keys.
Response
Whether the request succeeded.
Human-readable status message.
Array of widget settings objects.
Show data[]
Show data[]
Unique widget settings ID (UUID).
Display name of the bot shown in the widget header.
Whether the widget automatically starts a conversation when the page loads.
Widget position on the page. Values:
BOT_POSITION_BOTTOM_RIGHT, BOT_POSITION_BOTTOM_LEFT, BOT_POSITION_TOP_RIGHT, BOT_POSITION_TOP_LEFT, BOT_POSITION_UNSPECIFIED.URL of the bot avatar image displayed in the widget.
Inline SVG markup for the widget icon button.
Custom form fields shown to the user before starting a conversation (e.g. name, email, phone).
Widget color theme and styling configuration.
Language code for widget UI text (e.g.
en, es, fr).Body text of the consent/privacy modal shown before recording.
Title of the consent/privacy modal.
Whether these widget settings are currently active.
ISO 8601 timestamp when the settings were created.
ISO 8601 timestamp when the settings were last modified.
curl https://api.ravan.ai/api/v1/widget-settings/ \
-H "X-Api-Key: YOUR_API_KEY"
{
"success": true,
"message": "Widget settings fetched successfully",
"data": [
{
"id": "019d1fdb-6701-762d-97bd-93fc72606d7c",
"botName": "Ava Support",
"botAutoStart": false,
"botPosition": "bottom-right",
"customFormFields": null,
"theme": null,
"language": "en",
"isActive": true,
"createdAt": "2026-03-20T10:30:00Z",
"updatedAt": "2026-03-20T14:15:00Z"
}
]
}
⌘I