Get Embedded Chat Config For A Registered Agent

Retrieves embedded chat config for a specific agent by its id.

Get Embedded Chat Config For A Registered Agent

cURL

curl --request GET \
  --url https://{api_endpoint}/v1/orchestrate/agents/{id}/embedded-chat-config \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "<string>",
  "embedded_chat_config": {
    "layout": {
      "primary_color": "<string>",
      "second_color": "<string>",
      "accent_color": "<string>",
      "theme": "<string>",
      "enable_text_streaming": true,
      "form": {
        "type": "<string>",
        "properties": {
          "container_id": "<string>",
          "width": "<string>",
          "height": "<string>"
        }
      }
    },
    "is_live": true,
    "script": "<string>",
    "updated_at": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Response

200

application/json

Successful Response

Response model for embedded chat configuration.

id · string<uuid> string · required

Unique identifier for the agent or no_agent for UI get

tenant_id · string · required

ID of the tenant that owns this agent

embedded_chat_config · EmbeddedChatConfigOut · object · required

Embedded chat configuration

Show child attributes