> ## Documentation Index
> Fetch the complete documentation index at: https://docs.url2llm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Scrape public pages, discover site URLs, and extract page branding.

url2llm turns public URLs into content your application can use. Read a page as Markdown or HTML, capture its appearance, collect links and media, or inspect the visual identity visible on the page.

> **[Quickstart](https://docs.url2llm.com/getting-started/quickstart.md)**
>
> Get an API key, send a request, and check the response.

> **[Try the Playground](https://url2llm.com/dashboard/playground/scrape)**
>
> Inspect a public page in the dashboard before writing an integration.

## Make a request

Get an [organization API key](https://docs.url2llm.com/account/api-keys.md) and set `URL2LLM_API_KEY` as described in the quickstart. This request returns the main page content as Markdown:

```bash theme={null}
curl https://api.url2llm.com/v1/scrape \
  -H "Authorization: Bearer $URL2LLM_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://example.com","formats":{"markdown":true},"onlyMainContent":true}'
```

Read `data.markdown` after checking the response's `success` flag. `data.metadata` preserves the source URL, final URL, source status, and credits used. The [quickstart](https://docs.url2llm.com/getting-started/quickstart.md) includes cURL, Node.js, and Python examples.

## Choose an operation

| You have | You want | Use |
| - | - | - |
| A public URL | Page content and selected outputs | [Scrape API](https://docs.url2llm.com/features/scrape.md) |
| A starting URL or site | A list of candidate page URLs | [Map API](https://docs.url2llm.com/features/map.md) |
| A planned scrape request | Its credit cost before execution | [Quote API](https://docs.url2llm.com/guides/quote.md) |
| A public page | Its visible logos, colors, fonts, and component styles | [Branding output](https://docs.url2llm.com/features/branding.md) from a scrape |

A scrape reads one page synchronously. Map discovers URLs without scraping each one. Your application selects pages and owns multi-page scheduling, indexing, storage, and refreshes.

## Choose a page output

> **[Markdown and HTML](https://docs.url2llm.com/features/markdown-html.md)**
>
> Extract readable text or preserve markup for your workflow.

> **[Screenshots](https://docs.url2llm.com/features/screenshots.md)**
>
> Capture the viewport or full page as an inline image or public URL.

> **[Links and assets](https://docs.url2llm.com/features/links-assets.md)**
>
> Inspect page anchors and referenced images or videos.

> **[Branding](https://docs.url2llm.com/features/branding.md)**
>
> Read the visual identity expressed by a rendered page.

JavaScript rendering is enabled by default. Multiple supported formats can share one page fetch, and currently add no format or browser credit surcharge. Each ordinary scrape fetches fresh content. Use [browser rendering](https://docs.url2llm.com/guides/browser-rendering.md) for mobile, location, headers, and timing options.

## Account and operations

Signup provisions your first organization automatically. Every key in the organization shares its credit balance; personal sign-in and team roles control dashboard access separately.

> **[API keys](https://docs.url2llm.com/account/api-keys.md)**
>
> Create credentials, choose scopes, reveal secrets, rotate, and revoke keys.

> **[Team access](https://docs.url2llm.com/account/team-access.md)**
>
> Invite teammates, assign roles, and remove organization access.

> **[Billing and plans](https://docs.url2llm.com/account/billing.md)**
>
> Manage monthly allowances, prepaid credits, and auto-recharge.

> **[Usage and activity](https://docs.url2llm.com/account/usage.md)**
>
> Inspect requests, key usage, charges, and released reservations.

## Before production

Read [authentication](https://docs.url2llm.com/getting-started/authentication.md), [retries and idempotency](https://docs.url2llm.com/guides/retries.md), and [errors and limits](https://docs.url2llm.com/guides/errors.md). Check a representative page's output before scaling, keep its source metadata, and use a separate key for each service.

The API reference is generated from the implemented [OpenAPI contract](https://docs.url2llm.com/openapi-public.json). The separate Draft API and [draft scrape guide](https://docs.url2llm.com/drafts/scrape.md) describe proposed controls. Use the implemented guides for requests to the current API.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.