curl --request POST \
--url https://api.boostgpt.co/v1/bot/chat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "<string>",
"bot_id": "<string>",
"message": "<string>",
"provider_key": "<string>",
"provider_host": "<string>",
"model": "<string>",
"source_ids": [
"<string>"
],
"tags": [
"<string>"
],
"top": 5,
"instruction": "<string>",
"max_reply_tokens": 123,
"stream": false,
"chat_id": "<string>",
"reasoning_mode": "standard"
}
'{
"chat": {
"reply": "<string>",
"user": {
"uuid": "<string>",
"chat_id": "<string>",
"content": "<string>",
"role": "user",
"model": "<string>",
"complexity": "<string>",
"reasoning_type": "<string>",
"estimated_time_ms": "<string>",
"estimated_cost": "<string>",
"confidence": "<string>",
"channel": "<string>",
"credit_used": "<string>",
"confidence_score": "<string>",
"tokens": 123,
"upvotes": 123,
"downvotes": 123,
"reasoning": {},
"preference": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"updated_at": "2023-11-07T05:31:56Z",
"isToolExecuting": true
},
"agent": {
"uuid": "<string>",
"chat_id": "<string>",
"content": "<string>",
"role": "user",
"model": "<string>",
"complexity": "<string>",
"reasoning_type": "<string>",
"estimated_time_ms": "<string>",
"estimated_cost": "<string>",
"confidence": "<string>",
"channel": "<string>",
"credit_used": "<string>",
"confidence_score": "<string>",
"tokens": 123,
"upvotes": 123,
"downvotes": 123,
"reasoning": {},
"preference": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"updated_at": "2023-11-07T05:31:56Z",
"isToolExecuting": true
},
"preference": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"meta": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"usage": {
"prompt_tokens": 123,
"completion_tokens": 123,
"total_tokens": 123,
"reasoning_type": "<string>",
"conversation_count": 123,
"prompt_tokens_details": {
"cached_tokens": 123,
"audio_tokens": 123
},
"completion_tokens_details": {
"reasoning_tokens": 123,
"audio_tokens": 123,
"accepted_prediction_tokens": 123,
"rejected_prediction_tokens": 123
}
},
"config_used": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"analytics_id": 123,
"actual_time_ms": 123,
"type": "<string>",
"tool": {
"name": "<string>",
"description": "<string>",
"server_label": "<string>",
"parameters": {},
"parameterExplanation": "<string>",
"reasoning": "<string>"
},
"requiresApproval": true,
"executionId": "<string>",
"originalQuery": "<string>",
"context": "<string>",
"executedTools": [
{}
],
"isComplete": true,
"availableTools": 123,
"stepInfo": "<string>",
"hasMoreSteps": true,
"finalAnswer": "<string>",
"reasoningSteps": [
{
"cycle": 123,
"thought": "<string>",
"action": "<string>",
"actionInput": "<string>",
"observation": "<string>",
"actionSuccess": true,
"timestamp": "<string>",
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
]
}
],
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"totalSteps": 123,
"reasoning": [
{
"cycle": 123,
"thought": "<string>",
"action": "<string>",
"actionInput": "<string>",
"observation": "<string>",
"actionSuccess": true,
"timestamp": "<string>",
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
]
}
],
"reasoningCycles": [
{
"cycle": 123,
"thought": "<string>",
"action": "<string>",
"actionInput": "<string>",
"observation": "<string>",
"actionSuccess": true,
"timestamp": "<string>",
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
]
}
],
"totalCycles": 123,
"converged": true
}
}Send a message to an agent and receive a response
curl --request POST \
--url https://api.boostgpt.co/v1/bot/chat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "<string>",
"bot_id": "<string>",
"message": "<string>",
"provider_key": "<string>",
"provider_host": "<string>",
"model": "<string>",
"source_ids": [
"<string>"
],
"tags": [
"<string>"
],
"top": 5,
"instruction": "<string>",
"max_reply_tokens": 123,
"stream": false,
"chat_id": "<string>",
"reasoning_mode": "standard"
}
'{
"chat": {
"reply": "<string>",
"user": {
"uuid": "<string>",
"chat_id": "<string>",
"content": "<string>",
"role": "user",
"model": "<string>",
"complexity": "<string>",
"reasoning_type": "<string>",
"estimated_time_ms": "<string>",
"estimated_cost": "<string>",
"confidence": "<string>",
"channel": "<string>",
"credit_used": "<string>",
"confidence_score": "<string>",
"tokens": 123,
"upvotes": 123,
"downvotes": 123,
"reasoning": {},
"preference": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"updated_at": "2023-11-07T05:31:56Z",
"isToolExecuting": true
},
"agent": {
"uuid": "<string>",
"chat_id": "<string>",
"content": "<string>",
"role": "user",
"model": "<string>",
"complexity": "<string>",
"reasoning_type": "<string>",
"estimated_time_ms": "<string>",
"estimated_cost": "<string>",
"confidence": "<string>",
"channel": "<string>",
"credit_used": "<string>",
"confidence_score": "<string>",
"tokens": 123,
"upvotes": 123,
"downvotes": 123,
"reasoning": {},
"preference": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"updated_at": "2023-11-07T05:31:56Z",
"isToolExecuting": true
},
"preference": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"meta": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"usage": {
"prompt_tokens": 123,
"completion_tokens": 123,
"total_tokens": 123,
"reasoning_type": "<string>",
"conversation_count": 123,
"prompt_tokens_details": {
"cached_tokens": 123,
"audio_tokens": 123
},
"completion_tokens_details": {
"reasoning_tokens": 123,
"audio_tokens": 123,
"accepted_prediction_tokens": 123,
"rejected_prediction_tokens": 123
}
},
"config_used": {
"reasoningType": "<string>",
"model": "<string>",
"maxTokens": 123,
"complexity": "<string>"
},
"analytics_id": 123,
"actual_time_ms": 123,
"type": "<string>",
"tool": {
"name": "<string>",
"description": "<string>",
"server_label": "<string>",
"parameters": {},
"parameterExplanation": "<string>",
"reasoning": "<string>"
},
"requiresApproval": true,
"executionId": "<string>",
"originalQuery": "<string>",
"context": "<string>",
"executedTools": [
{}
],
"isComplete": true,
"availableTools": 123,
"stepInfo": "<string>",
"hasMoreSteps": true,
"finalAnswer": "<string>",
"reasoningSteps": [
{
"cycle": 123,
"thought": "<string>",
"action": "<string>",
"actionInput": "<string>",
"observation": "<string>",
"actionSuccess": true,
"timestamp": "<string>",
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
]
}
],
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
],
"totalSteps": 123,
"reasoning": [
{
"cycle": 123,
"thought": "<string>",
"action": "<string>",
"actionInput": "<string>",
"observation": "<string>",
"actionSuccess": true,
"timestamp": "<string>",
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
]
}
],
"reasoningCycles": [
{
"cycle": 123,
"thought": "<string>",
"action": "<string>",
"actionInput": "<string>",
"observation": "<string>",
"actionSuccess": true,
"timestamp": "<string>",
"sources": [
{
"citation_number": 123,
"source_id": "<string>",
"title": "<string>",
"url": "<string>",
"favicon": "<string>",
"type": "<string>",
"tags": [
"<string>"
]
}
]
}
],
"totalCycles": 123,
"converged": true
}
}Enter your API key
Project ID
Agent ID
The user's message
Optional API key for the AI provider
Optional host URL for the AI provider
Override the default model for this request
Specific memory sources to use
Filter memory by tags
Number of memory results to include
Override system instructions for this request
Maximum tokens in the response
Enable streaming response
Chat conversation ID (creates new if not provided)
Reasoning mode for the agent response (standard, interactive, stepwise, or react)
standard, interactive, stepwise, react Chat response received successfully
Response structure varies based on reasoning_mode. Contains 'chat' object with mode-specific fields.
Chat response data with mode-specific structure
Show child attributes
Agent's text response (present in all modes)
User message details
Show child attributes
Message unique identifier
Chat conversation ID
Message content
Message role
user, system AI model used
Complexity level
Reasoning type
Estimated time in milliseconds
Estimated cost
Confidence level
Communication channel
Credits used
Confidence score
Token count
Upvote count
Downvote count
Reasoning details
Show child attributes
Citation number
Source identifier
Source title
Source URL
Favicon URL
Source type
Source tags
Last update timestamp
Whether tool is executing
Agent message details
Show child attributes
Message unique identifier
Chat conversation ID
Message content
Message role
user, system AI model used
Complexity level
Reasoning type
Estimated time in milliseconds
Estimated cost
Confidence level
Communication channel
Credits used
Confidence score
Token count
Upvote count
Downvote count
Reasoning details
Show child attributes
Citation number
Source identifier
Source title
Source URL
Favicon URL
Source type
Source tags
Last update timestamp
Whether tool is executing
Token usage information
Show child attributes
Number of prompt tokens
Number of completion tokens
Total tokens used
Reasoning type used (for non-standard modes)
Number of conversation turns (for reasoning modes)
Analytics tracking ID
Actual processing time in milliseconds
Response type (interactive mode: 'tool_approval_required')
Tool information (interactive mode only)
Whether tool execution requires approval (interactive mode)
Execution ID (interactive mode)
Original user query (interactive mode)
Conversation context (interactive mode)
List of executed tools (interactive mode)
Whether reasoning is complete (interactive mode)
Number of available tools (interactive mode)
Step information (interactive mode)
Whether more steps remain (interactive mode)
Final answer (stepwise/react modes)
Reasoning steps (stepwise mode)
Show child attributes
Cycle number
Thought process
Action taken
Input for the action
Observation from action
Whether action succeeded
Timestamp of step
Sources used in this step
Show child attributes
Citation number
Source identifier
Source title
Source URL
Favicon URL
Source type
Source tags
Sources used (stepwise/react modes)
Total number of reasoning steps (stepwise mode)
Detailed reasoning cycles (stepwise/react modes)
Show child attributes
Cycle number
Thought process
Action taken
Input for the action
Observation from action
Whether action succeeded
Timestamp of step
Sources used in this step
Show child attributes
Citation number
Source identifier
Source title
Source URL
Favicon URL
Source type
Source tags
Reasoning cycles (react mode)
Show child attributes
Cycle number
Thought process
Action taken
Input for the action
Observation from action
Whether action succeeded
Timestamp of step
Sources used in this step
Show child attributes
Citation number
Source identifier
Source title
Source URL
Favicon URL
Source type
Source tags
Total reasoning cycles (react mode)
Whether reasoning converged (react mode)
Was this page helpful?