Documentation

Everything you need to choose a door, set up the right runtime, and connect APIClaw to your agent stack.

⬇️ Install

Local MCP setup for Claude Desktop, Cursor, and other local clients. The full OS-specific install flow lives on the install page.

Open install Sign in

Quick install:

# Auto-install to Claude Desktop
curl -fsSL https://apiclaw.cloud/install.sh | bash

# Or run the MCP server directly
npx @nordsym/apiclaw

OS-specific commands for macOS, Windows, and Linux live in the install guide. Use this page as the hub, not the full manual.

🔑 Auth (all four doors)

One command, every door. Opens your browser, one-tap sign-in via Clerk (Google or passwordless email), writes ~/.apiclaw.toml with mode 0600. The same file is read by the local MCP server, CLI, and HTTP gateway. Remote MCP uses its own OAuth 2.1 + DCR flow.

Canonical flow:

npx @nordsym/apiclaw auth login

Total time: ~10 seconds if you are already signed into Clerk in your browser. No inbox round-trip, no key copy-paste, no dashboard visit.

Switch accounts:

npx @nordsym/apiclaw auth login --force

Show current identity:

npx @nordsym/apiclaw auth whoami

Headless server or SSH (no browser available):

npx @nordsym/apiclaw auth login --email-fallback

Uses the legacy email magic-link flow — the link is delivered to your inbox, you click it, the CLI catches the callback over polling.

For MCP clients — agent_auth_required action

When the APIClaw MCP server has no local session, every tool returns a JSON payload with action: "agent_auth_required" and the exact CLI command to run. Agents that recognize this contract can resolve auth without human intervention.

⌨️ CLI

Terminal-native use for Codex, scripts, and CI/CD. Codex is one example, not the whole category. Run apiclaw auth login first (see Auth above), then use the direct commands below.

Direct tool parity:

apiclaw discover "currency conversion"
apiclaw details apilayer/fixer-latest
apiclaw call apilayer/fixer-latest --params '{"base":"USD","symbols":"EUR"}'
apiclaw balance

Install APIClaw into Codex / Cursor / Windsurf:

npx @nordsym/apiclaw setup --client codex   # or --client cursor / windsurf

Check status:

npx @nordsym/apiclaw doctor

Shows CLI path, auth status, connection health, and all client configurations.

⚡ HTTP

Server-side agents and custom runtimes. Use it from OpenClaw or any backend that sends requests with a workspace API key.

Endpoint

https://api.apiclaw.cloud/v1

Default model

apiclaw/openai/gpt-5.4-20260305

API key

sk-claw-...

Run apiclaw auth login — key is written to ~/.apiclaw.toml. Or generate one manually in workspace → API Keys.

Environment config:

OPENAI_BASE_URL=https://api.apiclaw.cloud/v1
OPENAI_API_KEY=sk-claw-<your-workspace-key>

Override route or model per request:

X-APIClaw-Route: fastest   # or: best_price, highest_quality, balanced

Response includes _apiclaw metadata: provider used, route reason, model resolved.

🔗 Remote MCP

Connected clients go through your workspace. Sign in first, then open Integrations to add or edit a connector. Grok, ChatGPT, Cursor, and other OAuth-capable clients fit here.

Step 1

Free email signup

Required for every door.

Step 2

Workspace

Same auth, same logs, same gateway.

Step 3

Integrations

Generate a connector for your client.

💡 Examples

Generate an image

// Find image-generation providers
discover_apis({ query: "text to image generation" })

// Send via APIClaw managed call
call_api({
  provider: "replicate",
  action: "flux-schnell",
  params: {
    prompt: "a coastal lobster trap at dawn"
  }
})

Search the web

call_api({
  provider: "brave_search",
  endpoint: "search",
  params: { query: "best MCP servers 2026" }
})

Generate speech

call_api({
  provider: "elevenlabs",
  endpoint: "tts",
  params: {
    text: "Hello, I am an AI agent!",
    voice: "adam"
  }
})

🔧 Tools Reference

apiclaw_help

Get help and see all available commands. Start here if you're new.

apiclaw_help()

discover_apis

Search 5,600+ APIs using natural language.

discover_apis({
  query: "send alerts to Sweden",
  max_results: 5
})

Parameters:

query - Natural language description
category - Filter: communication, search, ai
max_results - Number of results (default: 5)
region - Filter by region (e.g., "sweden")

get_api_details

Get detailed information about a specific API.

get_api_details({
  api_id: "replicate"
})

get_connected_providers

List all managed providers (no API key needed).

get_connected_providers()

Currently available:

openrouter - 800+ LLMs
replicate - Image, audio, ML models
elevenlabs - Text-to-speech
brave_search - Web search
firecrawl - Web scraping
apilayer - 22 callable APIs (rates, stocks, PDF, etc.)

call_api

Execute an API call through a managed provider.

call_api({
  provider: "brave_search",
  endpoint: "search",
  params: { q: "AI agents 2026" }
})

list_categories

Browse all API categories (30 main categories).

list_categories()

💬 Support

Need help? Reach out:

GitHub: Issues
Email: support_apiclaw@nordsym.com

📡 List your API on APIClaw

APIClaw indexes 26,701 APIs and 2,906 are empirically callable. Adding yours takes one OpenAPI spec and a free email signup.

01
Use the same workspace
Sign in at apiclaw.cloud/workspace. The same workspace covers your discoverable listing and any agent calls you make.
02
Submit your spec
Open Workspace → My APIs → Add API. Paste an OpenAPI 3 / Swagger URL, or describe the endpoint manually. APIClaw normalises auth, parameters, and pricing.
03
Approve the listing
Review the auto-generated capability tags (the keywords agents will match on), the pricing model, and a working example. Edit any field before going live.
04
Live and discoverable
Your API is searchable by discover_apis immediately. Per-call analytics show in your dashboard from the first agent that calls you.
05
Optional: managed-partner upgrade
Hand APIClaw the credential. We hold custody and agents call without keys. Commercial terms (flat fee, share, or hybrid) are agreed per partner.

Always free

Listing your API is free. Always. The managed-partner upgrade is opt-in.

List your API