Get an AI chatbot

Retrieves information on an AI chatbot.

AI agents are here; Go beyond AI chatbots and reimagine AI customer service with an AI agent platform that allows you to create AI agents that not only chat but think and act to resolve complex customer requests.

HTTP request

GET https://api-{application_id}.sendbird.com/v3/bots/{bot_userid}

Parameters

The following table lists the parameters that this action supports.

Required

Parameter name	Type	Description
bot_userid	string	Specifies the unique ID of a bot.

Response

If successful, this action returns a list of bot resources in the response body.

Status: 200 OK

{
    "bot_callback_url": "",
    "is_privacy_mode": false,
    "enable_mark_as_read": true,
    "show_member": false,
    "channel_invitation_preference": 0,
    "created_at": 1686141160,
    "bot": {
        "bot_userid": "Janes_ai_assistant",
        "bot_nickname": "Jane's ai assistant",
        "bot_profile_url": "",
        "bot_require_auth_for_profile_image": false,
        "bot_metadata": {},
        "bot_token": "10f514b570affa358002ae1a3edcbb27cb5cd1f9",
        "bot_type": "AI assistant"
    },
    "ai": {
        "backend": "chatgpt",
        "system_message": "You are a helpful assistant.",
        "temperature": 1.0,
        "max_tokens": 256,
        "top_p": 1.0,
        "presence_penalty": 0.0,
        "frequency_penalty": 0.0
    }
}

In the case of an error, an error object is returned. A detailed list of error codes is available here.

On this page

HTTP request Parameters Response