POSThttps://app.evoriqa.com/api/v1/chatbots

Create a chatbot

Creates a chatbot in the workspace. Counts against the plan's chatbot cap — over the cap returns 402 USAGE_LIMIT_REACHED. String fields are trimmed before validation.

Requires scope chatbots:write

Access is gated — enable it before your first call

The API is off by default. A request succeeds only when all three switches are on: the platform master switch (off by default), your organisation’s API toggle, and your plan or client entitlement. Any one off returns 403 API access is not enabled for this workspace.

Request body

Content type: application/json

Field	Type	Required	Description
name	string 1–120 chars	Required	Display name of the chatbot.
botName	string up to 120 chars	Optional	Name the bot introduces itself with.
description	string up to 2000 chars	Optional	Internal description.
tone	string one of `helpful` · `friendly` · `professional` · `casual` · `concise`	Optional	Reply tone preset.
greetingMessage	string up to 500 chars	Optional	First message shown to a visitor.
fallbackMessage	string up to 500 chars	Optional	Reply used when the AI has no grounded answer.
primaryColor	string matches `^#([0-9a-fA-F]{3}\|[0-9a-fA-F]{6})$`	Optional	Widget accent colour.

Request

curl

curl -X POST "https://app.evoriqa.com/api/v1/chatbots" \
  -H "x-api-key: $EVORIQA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Sales Assistant", "greetingMessage": "Hi! How can I help?" }'

Node.js

const res = await fetch("https://app.evoriqa.com/api/v1/chatbots", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVORIQA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Sales Assistant",
    "greetingMessage": "Hi! How can I help?"
  }),
});

const responseBody = await res.json();

Python

import os
import requests

res = requests.post(
    "https://app.evoriqa.com/api/v1/chatbots",
    headers={"Authorization": f"Bearer {os.environ['EVORIQA_API_KEY']}"},
    json={
      "name": "Sales Assistant",
      "greetingMessage": "Hi! How can I help?"
    },
)

body = res.json()

Response

200 OK

{
  "success": true,
  "data": {
    "id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
    "name": "Sales Assistant",
    "publicId": "cb_9x2k7m4q",
    "status": "active",
    "botName": "Ava",
    "description": null,
    "greetingMessage": "Hi! How can I help?",
    "fallbackMessage": null,
    "systemPrompt": null,
    "tone": "helpful",
    "language": "en",
    "temperature": 0.2,
    "maxContextChunks": 6,
    "similarityThreshold": 0.4,
    "maxReplySentences": null,
    "humanHandoffEnabled": true,
    "createdAt": "2026-01-15T09:24:00.000Z",
    "updatedAt": "2026-01-15T09:24:00.000Z"
  }
}