Get Tool Endpoint

GET /tools/{tool_id}

Get Tool by ID

cURL

curl --request GET \
  --url https://agent-prod.studio.lyzr.ai/v3/tools/{tool_id} \
  --header 'x-api-key: <api-key>'

200

{
  "id": "abc123",
  "name": "Sample Tool",
  "description": "This is a sample tool description.",
  "config": {}
}

Get Tool Endpoint

Endpoint

GET /v3/tools/{tool_id}

Description

Retrieves details of a specific tool by its ID.

Authentication

API Key (x-api-key) in the header.

Request Parameters

Parameter	Type	Description
tool_id	String	The ID of the tool to fetch.

Curl Request

curl -X GET "https://agent-prod.studio.lyzr.ai/v3/tools/{tool_id}" ^
-H "accept: application/json" ^
-H "x-api-key: sk-default-REDACTED"

Response

Returns the tool details, including configurations and settings.

Authorizations

x-api-key · string · header · required

Path Parameters

tool_id · string · required

The ID of the tool to fetch.

Response

200

application/json

Tool retrieved successfully

id · string

Example:

"abc123"

name · string

Example:

"Sample Tool"

description · string

Example:

"This is a sample tool description."

config · object

Example:

{}