Clatter Labs
Console

Agent

Describe the API

View as Markdown

The API's version, endpoints, the agent's tools and limits, and with a key, your key and balance.

GETapi.agent.clatterlabs.xyz/agent-config

Describes the API: version, endpoints, the agent's tools and limits. Works without a key; with a key and your Account ID it also returns the key's permissions, rate limit and your credit balance.

Call it without headers to discover the API, or with your key and Account ID to check them and see your balance before starting runs. Without a key the response is cacheable for 5 minutes.

Authorizations

Authorizationstring

Your API key as a bearer token: Bearer clsk_.... Create keys in the Console.

X-Clatter-Accountstring

The Account ID that owns the key, like CL-7K2M9QXA. Find it in Console › Settings. A missing value answers 401 missing_account_id; someone else's answers 401 account_mismatch.

Response

200 · application/json

versionstring

API version date.

agentobject

The agent: name, model family, tiers, tools and limits.

endpointsobject[]

Every endpoint with its method, path and required scope.

keyobject

Only when a key is sent: its id, name, scopes and rate_limit_rpm.

accountobject

Only when a key is sent: cloud_id, balance_usd, unlimited, can_run.

curl "https://api.agent.clatterlabs.xyz/agent-config" \
  -H "Authorization: Bearer $CLATTER_API_KEY" \
  -H "X-Clatter-Account: $CLATTER_ACCOUNT_ID"
import os
import requests

headers = {
    "Authorization": f"Bearer {os.environ['CLATTER_API_KEY']}",
    "X-Clatter-Account": os.environ["CLATTER_ACCOUNT_ID"],
}

r = requests.get("https://api.agent.clatterlabs.xyz/agent-config", headers=headers)
print(r.json())
const headers = {
  Authorization: `Bearer ${process.env.CLATTER_API_KEY}`,
  "X-Clatter-Account": process.env.CLATTER_ACCOUNT_ID,
};

const res = await fetch("https://api.agent.clatterlabs.xyz/agent-config", {
  method: "GET",
  headers,
});
console.log(await res.json());
{
  "object": "agent_config",
  "service": "Clatter Labs Agent API",
  "by": "Clatter Labs",
  "version": "2026-10-27",
  "base_url": "https://api.agent.clatterlabs.xyz",
  "auth": {
    "type": "bearer",
    "header": "Authorization: Bearer clsk_...",
    "account_header": "X-Clatter-Account: CL-...",
    "scopes": [
      "runs:write",
      "runs:read",
      "account:read"
    ]
  },
  "agent": {
    "name": "Cosmos",
    "product": "Cosmos Agent",
    "model": "SuperCosmos by Clatter Labs",
    "tiers": [
      "auto",
      "flash",
      "max",
      "heavy"
    ],
    "default_tier": "auto",
    "limits": {
      "max_steps_per_run": 150,
      "max_input_chars": 20000,
      "max_metadata_bytes": 2048,
      "max_runs_in_progress": 5
    }
  },
  "key": {
    "id": "key_7f3a…",
    "name": "CI bot",
    "scopes": [
      "runs:write",
      "runs:read"
    ],
    "rate_limit_rpm": 30
  },
  "account": {
    "cloud_id": "CL-7K2M9QXA",
    "balance_usd": 19.97,
    "unlimited": false,
    "can_run": true
  }
}
{
  "error": {
    "code": "invalid_api_key",
    "message": "This API key is invalid or was revoked."
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit: this key allows 30 requests per minute."
  }
}