List Tools

(v2)

GET

Lists the tools in your Confident AI project one page at a time, newest first. Retrieve a tool by id to read its input schema.

GET/v2/tools

curl -X GET "https://api.confident-ai.com/v2/tools" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "tools": [
      {
        "id": "<TOOL-ID>",
        "name": "get_customer_name",
        "version": "00.00.02"
      }
    ],
    "totalTools": 3,
    "page": 1,
    "pageSize": 25
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of results per page, at most 100. Defaults to 25.
searchTermstring
Returns only tools whose name contains this text.

Response

List Tools succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of tools, with the total across all pages.
Show 4 propertiesHide 4 properties
- toolslist of objects
  The tools for the current page, newest first.
  Show 3 propertiesHide 3 properties
  - idstring
    The id of the tool, generated by Confident AI.
  - namestring
    The name of the tool.
  - versionstring
    The latest version of the tool.
- totalToolsinteger
  The total number of tools in this project.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of tools per page.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI