Skip to main content
GET
/
tool
/
{id}
Get tool by ID
curl --request GET \
  --url https://api.iwy.ai/v1/tool/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "get_weather",
  "description": "Fetches the current weather for a given city",
  "server_url": "https://webhook.example.com/weather",
  "parameters_schema": {
    "type": "object",
    "required": [
      "city"
    ],
    "properties": {
      "city": {
        "type": "string",
        "description": "The name of the city"
      }
    },
    "additionalProperties": false
  },
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "x-api-key": "your-key"
  },
  "timeout_seconds": 20,
  "is_async": false,
  "strict_params": true,
  "auth_config": {},
  "tags": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Your iwy Service API Key. Find it at app.iwy.ai/settings.

Include it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Path Parameters

​
id
string<uuid>
required

The unique identifier (UUID) of the tool

Response

Tool retrieved successfully

Complete tool configuration

​
id
string<uuid>
required

Unique identifier for the tool

​
user_id
string<uuid>
required

ID of the user who owns this tool

​
name
string
required

Function name (snake_case)

Example:

"get_weather"

​
description
string
required

Clear explanation of what the tool does

Example:

"Fetches the current weather for a given city"

​
server_url
string<uri>
required

Webhook endpoint URL

Example:

"https://webhook.example.com/weather"

​
parameters_schema
object
required

JSON Schema defining the tool's parameters

Example:
{
  "type": "object",
  "required": ["city"],
  "properties": {
    "city": {
      "type": "string",
      "description": "The name of the city"
    }
  },
  "additionalProperties": false
}
​
method
enum<string>
default:POST
required

HTTP method

Available options:
POST,
GET,
PUT,
PATCH,
DELETE
​
headers
object

Custom HTTP headers

Example:
{
  "Content-Type": "application/json",
  "x-api-key": "your-key"
}
​
timeout_seconds
integer
default:20

Request timeout in seconds

Required range: 1 <= x <= 300
​
is_async
boolean
default:false

Whether the tool runs asynchronously

​
strict_params
boolean
default:true

Whether to strictly validate parameters

​
auth_config
object | null

Authentication configuration

​
tags
string[]

Tags for organization