Skip to main content
GET
/
ext
/
tool
/
{id}
Get Tool by ID
curl --request GET \
  --url https://api.trugen.ai/v1/ext/tool/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "0ea1fa09-4681-4068-8437-84ae6907b900",
  "type": "tool.client",
  "schema": {
    "type": "function",
    "name": "start_cloud_browser_session1",
    "parameters": {
      "type": "object",
      "properties": {},
      "required": [
        "<string>"
      ]
    },
    "description": "Starts the dashboard page with logged in session1."
  },
  "request_config": {
    "method": "GET",
    "url": "https://www.example.com/information",
    "headers": {
      "User-Agent": "Trugen Avatar",
      "Accept": "application/json"
    }
  },
  "event_messages": {
    "on_start": {
      "message": "<string>"
    },
    "on_success": {
      "message": "<string>"
    },
    "on_delay": {
      "delay": 123,
      "message": "<string>"
    },
    "on_error": {
      "message": "<string>"
    }
  },
  "is_active": true,
  "created_at": "2025-08-26T17:28:43.042453Z",
  "updated_at": "2025-08-26T17:28:43.042453Z"
}

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

The UUID of the tool

Example:

"0ea1fa09-4681-4068-8437-84ae6907b900"

Response

Tool details retrieved successfully

id
string<uuid>
required
Example:

"0ea1fa09-4681-4068-8437-84ae6907b900"

type
string
required
Example:

"tool.client"

schema
object
required

Function schema definition

request_config
object
required
event_messages
object
required
is_active
boolean
required
Example:

true

created_at
string<date-time>
required
Example:

"2025-08-26T17:28:43.042453Z"

updated_at
string<date-time>
required
Example:

"2025-08-26T17:28:43.042453Z"