---
title: "Create Or Update Embedded Chat Config For A Registered Agent"
method: PUT
path: "/v1/orchestrate/agents/{id}/embedded-chat-config"
tags: ["Agent embedded chat config"]
---

# Create Or Update Embedded Chat Config For A Registered Agent

`PUT /v1/orchestrate/agents/{id}/embedded-chat-config`

Create or update embedded chat config for a registered agent.

## Path parameters

- `id` string, required

## Request body

- EmbeddedChatConfigIn — Spec for embedded chat config in.
  - `layout` LayoutConfigInput — Layout configuration for embedded chat.
    - `primary_color` string, nullable — Primary color in hex format
    - `second_color` string, nullable — Secondary color in hex format
    - `accent_color` string, nullable — Accent color in hex format
    - `theme` string, nullable — Theme (light or dark)
    - `enable_text_streaming` boolean, nullable — Whether to enable text streaming
    - `form` FormConfig — Configuration for the embedded chat form.
      - `type` string, nullable — Type of the form (fullscreen-overlay, float, etc.)
      - `properties` FormProperties — Properties for the embedded chat form.
        - `container_id` string, nullable — ID of the container element
        - `width` string, nullable — Width of the chat container
        - `height` string, nullable — Height of the chat container
  - `is_live` boolean, nullable — Status of the embedded chat script

## Response `200`

Successful Response

- EmbeddedChatConfigOut — Spec for embedded chat config out.
  - `layout` LayoutConfigOutput — Layout configuration for embedded chat.
    - `primary_color` string, nullable — Primary color in hex format
    - `second_color` string, nullable — Secondary color in hex format
    - `accent_color` string, nullable — Accent color in hex format
    - `theme` string, nullable — Theme (light or dark)
    - `enable_text_streaming` boolean, nullable — Whether to enable text streaming
    - `form` FormConfig — Configuration for the embedded chat form.
      - `type` string, nullable — Type of the form (fullscreen-overlay, float, etc.)
      - `properties` FormProperties — Properties for the embedded chat form.
        - `container_id` string, nullable — ID of the container element
        - `width` string, nullable — Width of the chat container
        - `height` string, nullable — Height of the chat container
  - `is_live` boolean, nullable — Status of the embedded chat script
  - `script` string, nullable — Generated embedded chat script
  - `updated_at` string, nullable — Last update timestamp

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/ibm/apis/wxo-server-api.md) · [All operations](https://skmtc.net/ibm/apis/wxo-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ibm/wxo-server-api/revisions/82c114c37196/schema)