Skip to main content
This guide walks through the full flow: create an API from a URL, wait for it to build, then call it.

​
Prerequisites

​
Step 1: Create an API

Submit a URL and optionally describe the data you need: 
curl -X POST https://api.parse.bot/dispatch \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://books.toscrape.com",
    "task": "get book titles, prices, and ratings"
  }'
Response: 
{
  "task_id": "abc123-...",
  "matched": false,
  "may_require_auth": false
}
  • matched: true — an existing API was found, it’s ready immediately
  • matched: false — a build job was queued, poll until complete

​
Step 2: Poll for completion

curl https://api.parse.bot/dispatch/tasks/abc123-... \
  -H "X-API-Key: YOUR_API_KEY"
Keep polling until status is "completed". The response includes a generated_api object with all endpoint details: 
{
  "id": "abc123-...",
  "status": "completed",
  "generated_api": {
    "name": "Books to Scrape",
    "scraper_id": "scraper-456",
    "execution_base_url": "https://api.parse.bot/scraper/scraper-456",
    "endpoints": [
      {
        "method": "POST",
        "endpoint_name": "get_books",
        "description": "Get book listings with titles, prices, and ratings",
        "input_params": {
          "page": {"type": "integer", "description": "Page number"}
        },
        "return_schema": { ... }
      }
    ]
  }
}

​
Step 3: Call an endpoint

Use the execution_base_url and endpoint_name from the generated spec: 
curl -X POST https://api.parse.bot/scraper/scraper-456/get_books \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page": 1}'

​
Step 4: Export the spec (optional)

Get a standard OpenAPI spec for your API: 
curl https://api.parse.bot/dispatch/tasks/abc123-.../export/openapi \
  -H "X-API-Key: YOUR_API_KEY"
Or export as MCP tool definitions for use with AI agents: 
curl https://api.parse.bot/dispatch/tasks/abc123-.../export/mcp \
  -H "X-API-Key: YOUR_API_KEY"

​
Step 5: Connect your AI agent (optional)

Parse includes a hosted MCP server. Any MCP-compatible agent can connect and use all your APIs as tools. OAuth (recommended) — just the URL, your client handles login via browser: 
{
  "mcpServers": {
    "parse": {
      "url": "https://api.parse.bot/mcp"
    }
  }
}
API key — for clients without OAuth support: 
{
  "mcpServers": {
    "parse": {
      "url": "https://api.parse.bot/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}
Add either config to your claude_desktop_config.json, .cursor/mcp.json, or equivalent settings file.

​
What’s next

  • List all your APIs: GET /dispatch/tasks
  • Revise an API: POST /dispatch/tasks/{id}/revise with a description of what to change
  • Get SDK examples: GET /dispatch/tasks/{id}/sdk-example
  • Connect via MCP: POST /mcp — OAuth or API key, see Authentication