Create Chatbot

POST

api

external

chatbots

curl --request POST \
  --url https://v2.okchat.ai/api/external/chatbots \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "A helpful support assistant",
  "is_public": true,
  "name": "API Docs Demo Chatbot",
  "personality_config": {
    "style": "Friendly",
    "tone": "Professional"
  },
  "settings": {
    "greeting": "Hello! How can I assist you today?",
    "isRequestUserInfoEnabled": false,
    "isToolEnabled": true,
    "model": "gpt-4o-mini",
    "prompt": "You are a highly skilled customer support assistant for [company name]. Your goal is to provide accurate, polite, and concise answers to customer inquiries. If you do not know the answer, recommend the customer to contact human support or check the FAQ section. Ensure a positive tone in all responses",
    "snippet": {
      "header": "Customer Support",
      "logo": "https://example.com/logo.png",
      "name": "Support Assistant",
      "primaryColor": "#4F46E5",
      "secondaryColor": "#10B981",
      "slogan": "How can I help you today?"
    }
  },
  "slug": "api-docs-demo-chatbot"
}'

{
  "chatbot": {
    "active": true,
    "created_at": "2025-01-22T04:30:45.790337+00:00",
    "description": "A helpful support assistant",
    "docs_metadata": null,
    "enabled_plugins": null,
    "id": "3317853e-0af2-427d-a56f-351a9587f48f",
    "is_public": true,
    "managers": null,
    "migrated_data": false,
    "name": "API Docs Demo Chatbot",
    "openai_api_key": null,
    "organization_id": "123042b2-86e2-4184-a86e-95423d728815",
    "personality_config": {
      "style": "Friendly",
      "tone": "Professional"
    },
    "settings": {
      "greeting": "Hello! How can I assist you today?",
      "isRequestUserInfoEnabled": false,
      "isToolEnabled": true,
      "model": "gpt-4o-mini",
      "prompt": "You are a highly skilled customer support assistant for [company name]. Your goal is to provide accurate, polite, and concise answers to customer inquiries. If you do not know the answer, recommend the customer to contact human support or check the FAQ section. Ensure a positive tone in all responses",
      "snippet": {
        "header": "Customer Support",
        "logo": "https://example.com/logo.png",
        "name": "Support Assistant",
        "primaryColor": "#4F46E5",
        "secondaryColor": "#10B981",
        "slogan": "How can I help you today?"
      }
    },
    "slug": "api-docs-demo-chatbot",
    "suggestions": null,
    "updated_at": "2025-01-22T04:30:45.790337+00:00",
    "v1_chatbot_id": null,
    "version_id": null,
    "voice_widget_config": null
  },
  "message": "Chatbot created successfully"
}

Headers

x-api-key

string

Example:

"15a23c21867f4f38b0b46f5e4adb1caf87a040b34eb58f68"

Body

application/json

description

string

Example:

"A helpful support assistant"

is_public

boolean

Example:

true

name

string

Example:

"Customer Support External Bot"

personality_config

object

settings

object

slug

string

Example:

"customer-support-bot-97"

Response

201 - application/json

Example

chatbot

object

chatbot.active

boolean

Example:

true

chatbot.created_at

string

Example:

"2025-01-22T04:30:45.790337+00:00"

chatbot.description

string

Example:

"A helpful support assistant"

chatbot.docs_metadata

any | null

chatbot.enabled_plugins

any | null

chatbot.id

string

Example:

"3317853e-0af2-427d-a56f-351a9587f48f"

chatbot.is_public

boolean

Example:

true

chatbot.managers

any | null

chatbot.migrated_data

boolean

Example:

false

chatbot.name

string

Example:

"API Docs Demo Chatbot"

chatbot.openai_api_key

any | null

chatbot.organization_id

string

Example:

"123042b2-86e2-4184-a86e-95423d728815"

chatbot.personality_config

object

chatbot.settings

object

chatbot.slug

string

Example:

"api-docs-demo-chatbot"

chatbot.suggestions

any | null

chatbot.updated_at

string

Example:

"2025-01-22T04:30:45.790337+00:00"

chatbot.v1_chatbot_id

any | null

chatbot.version_id

any | null

message

string

Example:

"Chatbot created successfully"

Get Chatbots Update Chatbot

curl --request POST \
  --url https://v2.okchat.ai/api/external/chatbots \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "A helpful support assistant",
  "is_public": true,
  "name": "API Docs Demo Chatbot",
  "personality_config": {
    "style": "Friendly",
    "tone": "Professional"
  },
  "settings": {
    "greeting": "Hello! How can I assist you today?",
    "isRequestUserInfoEnabled": false,
    "isToolEnabled": true,
    "model": "gpt-4o-mini",
    "prompt": "You are a highly skilled customer support assistant for [company name]. Your goal is to provide accurate, polite, and concise answers to customer inquiries. If you do not know the answer, recommend the customer to contact human support or check the FAQ section. Ensure a positive tone in all responses",
    "snippet": {
      "header": "Customer Support",
      "logo": "https://example.com/logo.png",
      "name": "Support Assistant",
      "primaryColor": "#4F46E5",
      "secondaryColor": "#10B981",
      "slogan": "How can I help you today?"
    }
  },
  "slug": "api-docs-demo-chatbot"
}'

{
  "chatbot": {
    "active": true,
    "created_at": "2025-01-22T04:30:45.790337+00:00",
    "description": "A helpful support assistant",
    "docs_metadata": null,
    "enabled_plugins": null,
    "id": "3317853e-0af2-427d-a56f-351a9587f48f",
    "is_public": true,
    "managers": null,
    "migrated_data": false,
    "name": "API Docs Demo Chatbot",
    "openai_api_key": null,
    "organization_id": "123042b2-86e2-4184-a86e-95423d728815",
    "personality_config": {
      "style": "Friendly",
      "tone": "Professional"
    },
    "settings": {
      "greeting": "Hello! How can I assist you today?",
      "isRequestUserInfoEnabled": false,
      "isToolEnabled": true,
      "model": "gpt-4o-mini",
      "prompt": "You are a highly skilled customer support assistant for [company name]. Your goal is to provide accurate, polite, and concise answers to customer inquiries. If you do not know the answer, recommend the customer to contact human support or check the FAQ section. Ensure a positive tone in all responses",
      "snippet": {
        "header": "Customer Support",
        "logo": "https://example.com/logo.png",
        "name": "Support Assistant",
        "primaryColor": "#4F46E5",
        "secondaryColor": "#10B981",
        "slogan": "How can I help you today?"
      }
    },
    "slug": "api-docs-demo-chatbot",
    "suggestions": null,
    "updated_at": "2025-01-22T04:30:45.790337+00:00",
    "v1_chatbot_id": null,
    "version_id": null,
    "voice_widget_config": null
  },
  "message": "Chatbot created successfully"
}

API Documentation

API Reference

Headers

Body

Response