API Playground & Interactive Docs

Test Toolchi endpoints directly in your browser. Configure parameters on the left and see live JSON responses on the right.

Available Endpoints

Sandbox endpoints are open for testing. Production API keys, rate limits, and usage logging should be enabled before public launch.

Generate Blog Titles

Returns 5 high-impact blog title ideas based on a target topic and style tone.

POSThttps://toolchi.online/api/v1/ai/title-generator

curl -X POST https://toolchi.online/api/v1/ai/title-generator \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tc_live_xxxxxx" \
  -d ''

Payload Parameters

API Execution Response

Live Logs

Console Ready

Configure request params and click Run Query to trigger API handlers.

1. Quickstart (Get Started in 60 Seconds)

Integrating Toolchi automation in your codebase is simple. Follow these steps to trigger your first query:

Navigate to the Developer Console Dashboard.
Click the "Generate New API Key" button to compile your sandbox key (`tc_live_...` or `tc_test_...`).
Copy the token and attach it as a Bearer credentials token in the authorization headers of your POST requests.

2. Authentication Flow

All API requests directed to Toolchi server endpoints must include a secure authorization bearer token. Queries containing missing or invalid keys will fail with a `401 Unauthorized` response code.

Authorization: Bearer tc_live_your_actual_key_here

3. Response Status Codes Reference

Our REST endpoints utilize standard HTTP status indicators to communicate response status:

Status Code	Meaning	Description / Mitigation
200 OK	Success	The request completed successfully. Results are returned in the payload body.
400 Bad Request	Invalid Payload	Required parameters are missing, or JSON input formatting contains syntax errors.
401 Unauthorized	Access Denied	The Authorization header is missing, malformed, or using an inactive API key.
429 Too Many Requests	Rate Limit Exceeded	Your monthly request allocation has been exhausted. Upgrade your plan to increase limits.

4. Rate Limits & Throttling

API allocation is reset on the first day of each calendar month. The standard **Developer API Plus** plan provides a quota of 25,000 requests/month. Standard headers are appended to all endpoints to monitor usage margins:

X-RateLimit-Limit: Total allowed requests inside the current billing cycle.
X-RateLimit-Remaining: Number of requests remaining for the active calendar month.

5. Webhooks & Event Receivers

Register a destination Webhook URL in your Developer Console to receive asynchronous callback triggers. Once long-running operations (like bulk video conversions) complete, we transmit a POST request with the following JSON format:

{
  "event": "tool.completed",
  "timestamp": 1783588755,
  "payload": {
    "tool_slug": "compress-image",
    "status": "success",
    "output_file": {
      "name": "hero-optimized.webp",
      "size_bytes": 104857,
      "url": "https://api.toolchi.online/outputs/f837d7a8-44fa-41ea-bfcf-7a3891b29a28"
    }
  }
}