Skip to main content
POST
/
agents
/
{agentId}
/
conversations
/
{conversationId}
/
tool-result
Submit a tool result
curl --request POST \
  --url https://www.chatbase.co/api/v2/agents/{agentId}/conversations/{conversationId}/tool-result \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "toolCallId": "<string>",
  "output": "<unknown>"
}
'
import requests

url = "https://www.chatbase.co/api/v2/agents/{agentId}/conversations/{conversationId}/tool-result"

payload = {
"toolCallId": "<string>",
"output": "<unknown>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({toolCallId: '<string>', output: '<unknown>'})
};

fetch('https://www.chatbase.co/api/v2/agents/{agentId}/conversations/{conversationId}/tool-result', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://www.chatbase.co/api/v2/agents/{agentId}/conversations/{conversationId}/tool-result",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'toolCallId' => '<string>',
'output' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://www.chatbase.co/api/v2/agents/{agentId}/conversations/{conversationId}/tool-result"

payload := strings.NewReader("{\n \"toolCallId\": \"<string>\",\n \"output\": \"<unknown>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://www.chatbase.co/api/v2/agents/{agentId}/conversations/{conversationId}/tool-result")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"toolCallId\": \"<string>\",\n \"output\": \"<unknown>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://www.chatbase.co/api/v2/agents/{agentId}/conversations/{conversationId}/tool-result")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"toolCallId\": \"<string>\",\n \"output\": \"<unknown>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "success": true
  }
}
{
"error": {
"code": "VALIDATION_INVALID_BODY",
"message": "Invalid request"
}
}
{
"error": {
"code": "AUTH_MISSING_API_KEY",
"message": "Authentication required"
}
}
{
"error": {
"code": "SUBSCRIPTION_API_RESTRICTED_PLAN",
"message": "A Standard plan or higher is required to access the API"
}
}
{
"error": {
"code": "RESOURCE_TOOL_CALL_NOT_FOUND",
"message": "Tool call not found or expired"
}
}
{
"error": {
"code": "RATE_LIMIT_TOO_MANY_REQUESTS",
"message": "Too many requests, please try again later"
}
}
{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Something went wrong, please try again"
}
}

Authorizations

Authorization
string
header
required

API key from your account settings

Path Parameters

agentId
string
required

The agent ID

Minimum string length: 1
Example:

"5QHA6VB-DIAbBhxwqxfdi"

conversationId
string
required

The conversation ID

Minimum string length: 1
Example:

"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"

Body

application/json
toolCallId
string
required

The toolCallId from the tool-call part in the chat response

Minimum string length: 1
output
any

The result of executing the tool action

Response

Tool result submitted successfully

data
object
required