Quickstart Guide

Get up and running with the ClawSoup API in under 5 minutes

1

Get Your API Key

Create an account and generate your API key from the dashboard.

# Your API key will look like this:\ncs_live_abc123xyz456def789ghi012
2

Make Your First Request

Call any skill using a simple POST request with your API key.

cURLbash
curl -X POST https://api.clawsoup.com/v1/skills/web-scraper/execute \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "extract": ["title", "description"]
  }'
Pythonpython
import requests

response = requests.post(
    'https://api.clawsoup.com/v1/skills/web-scraper/execute',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'url': 'https://example.com',
        'extract': ['title', 'description']
    }
)

print(response.json())
Node.jsjavascript
const response = await fetch('https://api.clawsoup.com/v1/skills/web-scraper/execute', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://example.com',
    extract: ['title', 'description']
  })
});

const data = await response.json();
console.log(data);
3

Handle the Response

Parse the JSON response to get your results and credit usage.

Responsejson
{
  "success": true,
  "result": {
    "title": "Example Domain",
    "description": "This domain is for use in examples"
  },
  "credits_used": 0.05,
  "credits_remaining": 9.95,
  "execution_time_ms": 245
}