---
title: "Test a tool configuration"
method: POST
path: "/v1/tools/{id}/test"
tags: ["Agents"]
---

# Test a tool configuration

`POST /v1/tools/{id}/test`

## Request

- Base URL: `https://api.pyai.com`
- URL: `https://api.pyai.com/v1/tools/{id}/test`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-api-key`

## Path parameters

- `id` string, required

## Response `200`

Dry-run result

- ToolTestResult
  - `object` string
  - `tool_id` string
  - `name` string
  - `ok` boolean
  - `message` string

## Other responses

- `401`: Missing or invalid API key (`code: unauthorized`)
- `404`: No such tool

---

[API](https://skmtc.dev/pyai/apis/pyai-api.md) · [All operations](https://skmtc.dev/pyai/apis/pyai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pyai/apis/pyai-api/revisions/271a1539185b?raw)