GET
/
api
/
agents
/
{agentId}
/
tools

This endpoint retrieves a list of all tools configured for a specific agent. The response is an array of tool objects, where the structure of each object depends on its type.

​
Responses

The response will be an array containing different types of tool objects. Below are examples for each type.

​
Datastore Tool

This tool connects to a specific datastore to retrieve information.

{
  "id": "clwscf12b000108l6d5s7g8h9",
  "type": "datastore",
  "datastoreId": "clq5g0p5k0001l60t7p1f3b2a"
}

​
HTTP Tool

A versatile tool for making requests to any external API. The config object contains all the necessary details for the HTTP request.

{
  "id": "clwscf12b000208l6e4f3h7j8",
  "type": "http",
  "isRaw": false,
  "config": {
    "name": "Set conversation Status (form)",
    "description": "Change the Status of a conversation between RESOLVED, UNRESOLVED or HUMAN_REQUESTED.",
    "url": "https://api.chatvolt.ai/api/conversations/:conversation_id/set-status",
    "method": "POST",
    "withApproval": false,
    "headers": [
      {
        "key": "Authorization",
        "value": "Bearer <bearer-token>",
        "isUserProvided": false,
        "description": "",
        "acceptedValues": []
      }
    ],
    "body": [
      {
        "key": "status",
        "value": "",
        "isUserProvided": true,
        "description": "New conversation status",
        "acceptedValues": [
          "RESOLVED",
          "UNRESOLVED",
          "HUMAN_REQUESTED"
        ]
      }
    ],
    "queryParameters": [],
    "pathVariables": [
      {
        "key": "conversation_id",
        "value": "",
        "isUserProvided": true,
        "description": "use {conversation-id}",
        "acceptedValues": []
      }
    ],
    "hasMaximumToolCalls": true,
    "maximumToolCalls": 1,
    "isErrorCountable": true
  }
}

​
Delayed Responses Tool

This tool allows the agent to wait for a specified amount of time before sending the next message.

{
  "id": "clwscf12b000308l6g2k4c9a2",
  "type": "delayed_responses",
  "config": {
    "delay": 30
  }
}

​
Follow-up Messages Tool

This tool enables the agent to send a sequence of follow-up messages at specified intervals.

{
  "id": "clwscf12b000408l6h1d8b3e7",
  "type": "follow_up_messages",
  "config": {
    "max_sends": 3,
    "interval_hours": 24,
    "messages": "Hello! Just checking in.||Any updates on our previous conversation?||I'm closing this chat now, but feel free to reach out if you need anything else."
  }
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agentId
string
required

Response

200 - application/json
id
string
type
enum<string>
required
Available options:
http,
datastore,
mark_as_resolved,
request_human,
delayed_responses,
follow_up_messages
datastoreId
string

Required when type is 'datastore'.

formId
string

Required when type is 'form'.

isRaw
boolean

Only applicable when type is 'http'. If true, the tool is configured with a raw cURL command.

config
object

Configuration object that varies based on the tool 'type'.

Was this page helpful?

Enable/Disable Agent IntegrationCreate Tool