Get Widget Settings

Get Widget Settings.

GET /api/v1/widget-settings/{id}

Get Widget Settings

cURL

curl --request GET \
  --url https://api.ravan.ai/api/v1/widget-settings/{id}/ \
  --header 'X-Api-Key: <api-key>'

200

{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "id": "id_123",
    "bot_name": "Support Bot",
    "bot_auto_start": true,
    "bot_position": "BOT_POSITION_BOTTOM_RIGHT",
    "bot_logo": "https://example.com/logo.png",
    "svg_logo": "https://example.com/logo.png",
    "custom_form_fields": {},
    "theme": {},
    "language": "en",
    "consent_content": "example",
    "consent_title": "example",
    "is_active": true,
    "created_at": "2026-03-14T12:00:00Z",
    "updated_at": "2026-03-14T12:00:00Z"
  }
}

Authorizations

X-Api-Key · string · required

Your Agni API key. Find it in your RavanAi.

---

Path Parameters

id · string · required

Widget Settings ID

---

Response

success · boolean

Whether the request succeeded.

message · string

Human-readable status message.

data · object

Returned data.

Show data

id · string

Unique widget settings ID

bot_name · string

Display name of the bot

bot_auto_start · boolean

Whether the bot starts automatically

bot_position · string

bot_position field. Allowed values: BOT_POSITION_UNSPECIFIED, BOT_POSITION_BOTTOM_RIGHT, BOT_POSITION_BOTTOM_LEFT, BOT_POSITION_TOP_RIGHT, BOT_POSITION_TOP_LEFT.

bot_logo · string

URL of the bot logo image

svg_logo · string

SVG logo content

custom_form_fields · object

Custom form field configuration

theme · object

Widget theme configuration

language · string

Language code (e.g. en, fr)

consent_content · string

Consent modal body text

consent_title · string

Consent modal title

is_active · boolean

Whether these widget settings are active

created_at · string

Creation timestamp

updated_at · string

Last update timestamp

200

{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "id": "id_123",
    "bot_name": "Support Bot",
    "bot_auto_start": true,
    "bot_position": "BOT_POSITION_BOTTOM_RIGHT",
    "bot_logo": "https://example.com/logo.png",
    "svg_logo": "https://example.com/logo.png",
    "custom_form_fields": {},
    "theme": {},
    "language": "en",
    "consent_content": "example",
    "consent_title": "example",
    "is_active": true,
    "created_at": "2026-03-14T12:00:00Z",
    "updated_at": "2026-03-14T12:00:00Z"
  }
}

Authorizations

X-Api-Key · string · header · required

Path Parameters

id · string · required

Widget Settings ID

Response

200 - application/json

Successful response

success · boolean

message · string

data · object

Show child attributes