ANanam
Tools

get tool

Changed on

Get a tool by ID

get/v1/tools/{id}

Request

  • Base URL
    https://api.anam.ai
  • URL
    https://api.anam.ai/v1/tools/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Tool ID

Response

Successfully retrieved tool

idstring uuid

Unique identifier for the tool

namestring

Name of the tool

descriptionstring

Description of what the tool does

type'CLIENT' | 'SERVER_RAG' | 'SERVER_WEBHOOK' | 'SYSTEM'

Type of tool

configobject

Type-specific configuration

disableInterruptionsboolean

When true, interruptions are disabled while this tool is executing

createdAtstring date-time

When the tool was created

updatedAtstring date-time nullable

When the tool was last updated

usageCountinteger

Number of the organization's live personas using this tool

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "search_knowledge_base",
  "description": "Search the knowledge base for product information"
}

Changes