Quickstart

Get your first URL converted to Markdown in under 5 minutes.

1. Create an Account

Registration is currently invite-only. Check back soon.

2. Get Your API Key

After verifying your email, go to your dashboard and create an API key. Copy it immediately—it's only shown once.

3. Make Your First Request

Use curl or your favorite HTTP client:

curl -X POST https://urlplain.com/v2/scrape \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

4. Response

{
  "success": true,
  "data": {
    "markdown": "# Example Domain\n\nThis domain is for use in examples...",
    "metadata": {
      "title": "Example Domain",
      "url": "https://example.com",
      "statusCode": 200
    }
  }
}

Using the Firecrawl SDK

Since Urlplain is Firecrawl-compatible, you can use the official Firecrawl SDK with a custom base URL:

# Python
from firecrawl import FirecrawlApp
app = FirecrawlApp(api_key="YOUR_API_KEY", api_url="https://urlplain.com")
result = app.scrape_url("https://example.com")

# Node.js
import FirecrawlApp from '@mendable/firecrawl-js';
const app = new FirecrawlApp({ apiKey: "YOUR_API_KEY", apiUrl: "https://urlplain.com" });
const result = await app.scrapeUrl("https://example.com");

Full API Reference →