API Reference

OpenAPI specification and the execute contract for the IT-ToolBox REST API.

Download openapi.yaml

OpenAPI 3.0

The published spec covers authentication, API keys, tool execution (102 server tools, 7 client-only), workspaces, and marketplace endpoints. Import it into Swagger UI, Postman, or Insomnia.

Base URL

API
/api/v1

Execute

Run a server tool with POST /execute/{tool}. The path segment is the tool id (for example json-formatter). Arguments always sit under input.

Request
POST /api/v1/execute/json-formatter
Content-Type: application/json
X-API-Key: YOUR_API_KEY

{
  "input": {
    "json": "{\"a\":1}",
    "indent": 2
  }
}

Aliases such as /tools/{slug}/execute are also accepted where documented in OpenAPI.

Response format

HTTP 200
{
  "status": "success",
  "code": 200,
  "data": {
    "output": { }
  }
}

Rate limits

API traffic is rate limited. When a limit is exceeded the API returns 429 Too Many Requests. Back off exponentially and honor reset headers when present.

HeaderDescription
X-Ratelimit-LimitMaximum requests in the current window
X-Ratelimit-RemainingRemaining requests in the window
X-Ratelimit-ResetSeconds until the window resets

Tool catalog

Every tool has a dedicated documentation page with sample input, cURL, and a link to the interactive UI.