Skip to content

Report a browser-executed agent tool failure

POST
/api/agent/client-tool-failure
curl --request POST \
--url http://localhost:8080/api/agent/client-tool-failure \
--header 'Content-Type: application/json' \
--cookie auth_session=<auth_session> \
--data '{ "workspaceId": "example", "chatId": "example", "toolName": "example", "toolCallId": "example", "error": "example", "code": "example" }'
Media typeapplication/json
object
workspaceId
required
string
chatId
required
string
<= 128 characters
toolName
required
string
>= 1 characters <= 128 characters
toolCallId
required
string
>= 1 characters <= 256 characters
error
required
string
>= 1 characters <= 2000 characters
code
string
<= 128 characters

Example generated

{
"workspaceId": "example",
"chatId": "example",
"toolName": "example",
"toolCallId": "example",
"error": "example",
"code": "example"
}

Successful response

Media typeapplication/json
object
success

Whether the request succeeded.

boolean
data

Endpoint-specific response payload.

message
string
error
string

Example

{
"message": "Operation completed",
"error": "Error message"
}

Invalid request

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}

Internal server error

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}