curl --request GET \
--url https://api.boostgpt.co/v1/bot/readall \
--header 'Authorization: Bearer <token>'{
"bots": [
{
"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>"
}
],
"pagination": {
"page": 123,
"per_page": 123,
"total": 123,
"total_pages": 123
}
}Fetch a paginated list of all agents in a project
curl --request GET \
--url https://api.boostgpt.co/v1/bot/readall \
--header 'Authorization: Bearer <token>'{
"bots": [
{
"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>"
}
],
"pagination": {
"page": 123,
"per_page": 123,
"total": 123,
"total_pages": 123
}
}Enter your API key
Project ID
Page number
Items per page
Agents retrieved successfully
Show child attributes
Agent unique identifier
Agent unique identifier
Agent subdomain
AI provider API key
Agent avatar filename
Agent name
AI model being used
Default reasoning type for the agent
Maximum reply tokens
Number of top memory results to use
System instructions for the agent
Custom rate limit message
Rate limit time window in seconds
Maximum requests per time window
Default reply when agent has no answer
Whether login is required (0 = no, 1 = yes)
Whether memory is enabled (0 = no, 1 = yes)
Whether to hide branding (0 = no, 1 = yes)
Agent branding configuration
Show child attributes
UI theme (e.g., light, dark)
Input placeholder text
Accent color hex code
Background color hex code
Agent status (0 = inactive, 1 = active)
Last active timestamp
Last update timestamp
List of enabled integrations
Full avatar URL
Agent's public domain URL
Was this page helpful?