---
title: "Create Chat Bot"
method: POST
path: "/webchat/chat-bots"
tags: ["Web Chat"]
---

# Create Chat Bot

`POST /webchat/chat-bots`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/webchat/chat-bots`
- Auth: HTTP bearer

Create a chat bot.

`agent_id` seeds the bot with an answering agent. Omitted, the bot is
created with none and answers nothing until an agent is mapped with
`POST /webchat/agents`.

## Headers

- `Idempotency-Key` string, nullable: Retry-safety key for this create. Replaying the same key returns the FIRST result instead of creating a second row. Durability depends on the tenant's migration state, so treat it as best-effort.
- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ChatBotCreateRequest: A new chat bot. An org can run several. `chat_bot_id` is REQUIRED on almost every other call on this surface because the same org's agents, buttons, questions, blogs and theme are all per-bot - so create one of these first, or read the org's existing bots from `GET /webchat/chat-bots`.
  - `name` string, required
  - `agent_id` string, nullable: Optional voice/text agent id used to seed the new bot's external chat agent. When omitted, no agent row is created.
  - `agent_name` string, nullable: Display name of the selected agent. Stored on the agent row so the widget shows the AGENT's name, not the bot's. Falls back to the bot name when omitted.

## Response `201`

Successful Response

- ApiResponseWebchatPayload
  - `data` WebchatPayload, required: An open envelope for one webchat object. Open because the widget's config grows a field per product decision and a pinned schema would DROP it. Same choice the desk surface made.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)