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/019d1fdb-6701-762d-97bd-93fc72606d7c/ \
-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
Get Widget Settings
Retrieve the full configuration of a single widget settings object by its ID.
GET
/
api
/
v1
/
widget-settings
/
{id}
curl https://api.ravan.ai/api/v1/widget-settings/019d1fdb-6701-762d-97bd-93fc72606d7c/ \
-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.
Path Parameters
The unique UUID of the widget settings to retrieve.
Response
Whether the request succeeded.
Human-readable status message.
The widget settings object.
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 on page load.
Widget position. 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.
Inline SVG markup for the widget icon button.
Custom form fields configuration.
Widget color theme and styling.
Language code (e.g.
en, es, fr).Consent modal body text.
Consent modal title.
Whether these settings are active.
Creation timestamp (ISO 8601).
Last update timestamp (ISO 8601).
curl https://api.ravan.ai/api/v1/widget-settings/019d1fdb-6701-762d-97bd-93fc72606d7c/ \
-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