Skip to main content
GET
/
v1
/
bot
/
read
Get Agent
curl --request GET \
  --url https://api.boostgpt.co/v1/bot/read \
  --header 'Authorization: Bearer <token>'
{
  "bot": {
    "id": "<string>",
    "uuid": "<string>",
    "subdomain": "<string>",
    "provider_key": "<string>",
    "avatar": "<string>",
    "name": "<string>",
    "model": "<string>",
    "reasoning_type": "<string>",
    "max_reply_tokens": "<string>",
    "top": 123,
    "instruction": "<string>",
    "ratelimit_message": "<string>",
    "ratelimit_seconds": 123,
    "ratelimit_requests": 123,
    "no_answer_reply": "<string>",
    "require_login": 123,
    "memory": 123,
    "hide_branding": 123,
    "branding": {
      "seo": {
        "title": "<string>",
        "keywords": "<string>",
        "description": "<string>"
      },
      "logo": {
        "url": "<string>",
        "enabled": true
      },
      "theme": "<string>",
      "favicon": {
        "url": "<string>",
        "enabled": true
      },
      "tagline": {
        "content": "<string>",
        "enabled": true
      },
      "navigation": {
        "links": [
          {}
        ],
        "enabled": true
      },
      "description": {
        "content": "<string>",
        "enabled": true
      },
      "placeholder": "<string>",
      "accent_color": "<string>",
      "background_color": "<string>",
      "message_greetings": {
        "enabled": true,
        "greetings": [
          "<string>"
        ]
      },
      "conversation_starters": {
        "enabled": true,
        "prompts": [
          "<string>"
        ]
      }
    },
    "status": 123,
    "active_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "integrations": [
      {}
    ],
    "avatar_link": "<string>",
    "domain": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Enter your API key

Query Parameters

project_id
string
required

Project ID

bot_id
string
required

Agent ID

Response

Agent retrieved successfully

Complete agent details (for Create/Read operations)

bot
object

Agent/Bot object (used in list responses)