Create Or Update Embedded Chat Config For A Registered Agent

Create or update embedded chat config for a registered agent.

Create Or Update Embedded Chat Config For A Registered Agent

cURL

curl --request PUT \
  --url https://{api_endpoint}/v1/orchestrate/agents/{id}/embedded-chat-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
}
'

200

{
  "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

Body

application/json

Spec for embedded chat config in.

layout · LayoutConfig · object

Layout configuration

Show child attributes

is_live · boolean | null

Status of the embedded chat script

Response

200

application/json

Successful Response

Spec for embedded chat config out.

layout · LayoutConfig · object

Layout configuration

Show child attributes

is_live · boolean | null

Status of the embedded chat script

script · string | null

Generated embedded chat script

updated_at · string | null

Last update timestamp