Skip to content
All docs

Quickstart

Create an API key and scrape your first page.

url2llm turns one public URL into Markdown and other requested outputs. Each scrape is synchronous. Start by creating an organization API key in the dashboard.

1. Create a key

Sign up, open Dashboard > API keys, and create a key with the scrape scope. Copy the secret when it appears. It is shown once. Store it in a server-side secret manager, never in browser code.

2. Send a request

curl https://api.url2llm.com/v1/scrape \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://example.com","formats":["markdown","links"]}'

The response has a success flag, a data object, and a request_id. Requested outputs appear in data. The metadata object includes the source URL, final URL, source status code, cache status, and credits used.

{
  "success": true,
  "data": {
    "metadata": {
      "source_url": "https://example.com/",
      "final_url": "https://example.com/",
      "status_code": 200,
      "from_cache": false,
      "credits_used": 1
    },
    "markdown": "# Example Domain",
    "links": []
  },
  "request_id": "..."
}

This response is illustrative. Page content and link lists depend on the source.

3. Build a page list

Use POST /v1/map to discover URLs from a site's sitemaps and homepage links. Select the URLs your application needs, then call POST /v1/scrape for each. The API does not run a managed crawl job.

Next steps

Read formats and options to choose output and cache behavior. Call POST /v1/quote before scraping when you need the credit cost.