Getting Started

A short path from zero to a verified execute call against the IT-ToolBox API.

1. Create an account

Register at /register or sign in at /login. Confirm your email when prompted so dashboard features unlock cleanly.

2. Generate an API key

Open API Keys in the dashboard. Create a key with a clear name such as ci-pipeline or local-dev.

The full key is shown once at creation time. Copy it immediately into a secrets manager or environment variable. If you lose it, revoke the key and create another.

3. Call the execute endpoint

Send POST /execute/{tool} with your key and a JSON body. The payload always nests tool arguments under input.

cURL
curl -X POST /api/v1/execute/json-formatter \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{"json":"{\"a\":1}","indent":2}}'

Prefer the typed client? See the SDK guide.

4. Explore tools in the browser

Many tools run entirely in the browser and need no API key. Browse the tools catalog, open any tool UI, or press ⌘K to search the command palette.

What to read next

  • Authentication for headers, storage, and rotation practices.
  • API Reference for response envelopes and rate limits.
  • Tools for per-tool sample input and execute URLs.