get tool

Get a tool by ID

GET /v1/tools/{id}

get tool

cURL

curl --request GET \
  --url https://api.anam.ai/v1/tools/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "0084f07b-6106-4cd8-be32-a66a64284b31",
  "name": "search_knowledge_base",
  "description": "Search the knowledge base for product information",
  "type": "CLIENT",
  "config": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "usageCount": 123
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string<uuid> · required

Tool ID

Response

200

application/json

Successfully retrieved tool

id · string<uuid>

Unique identifier for the tool

Example:

"0084f07b-6106-4cd8-be32-a66a64284b31"

name · string

Name of the tool

Example:

"search_knowledge_base"

description · string

Description of what the tool does

Example:

"Search the knowledge base for product information"

type · enum<string>

Type of tool

Available options: CLIENT, SERVER_RAG, SERVER_WEBHOOK, SYSTEM

config · object

Type-specific configuration

createdAt · string<date-time>

When the tool was created

updatedAt · string<date-time> | null

When the tool was last updated

usageCount · integer

Number of personas using this tool