Browse documentation

Start here

Quickstart

From a blank workspace to your first Tool result: create a key, read the catalog, call a Tool.

~5 minutesREST or MCP

1. Create an API key

Open Settings → Developer in your workspace and create a key. The key is shown once and stored as a hash, so copy it before you close the dialog.

Grant tools.read for Tools that only read data. Add tools.write when the integration will call Tools that change workspace data, such as adding competitors.

2. Read the catalog

GET /openapi/v1/tools returns every Tool the key can reach, with its schemas and its maximum credit price. It is the authoritative list; the pages in this reference are generated from the same source.

200 OK (trimmed)
curl https://api.cuekoo.com/openapi/v1/tools \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "tools": [
    {
      "name": "get_balance",
      "title": "Get credit balance",
      "scope": "tools.read",
      "max_credits": 0
    }
  ]
}

Each entry carries input_schema and output_schema as JSON Schema. A model can use them directly; the API reference renders the same schemas as tables.

3. Call a Tool

Send the arguments as a JSON object. list_my_accounts is a free, read-only Tool that answers with the channels connected to this workspace.

curl -X POST https://api.cuekoo.com/openapi/v1/tools/list_my_accounts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

The response is the Tool's output object itself, at HTTP 200. Errors use the error envelope.

4. Check what it cost

get_balance is free and always safe to call. available is what you can spend now; held is reserved by calls still running; used_this_period is what this billing period has consumed.

POST /openapi/v1/tools/get_balance
curl -X POST https://api.cuekoo.com/openapi/v1/tools/get_balance \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{
  "plan": {
    "name": "Starter",
    "channels_used": 2,
    "channels_limit": 5,
    "creators_used": 12,
    "creators_limit": 50
  },
  "available": 940,
  "held": 0,
  "used_this_period": 60
}

Paid Tools reserve their maximum price before they run and settle the difference afterwards. The credits page lists every paid Tool.

Next steps

Next: authentication