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

# Quickstart

> Start using Norns.ai APIs in under 5 minutes

## Getting Started

Learn how to integrate Norns.ai's powerful web scraping and mapping capabilities into your applications.

### Authentication

All API requests require an API key passed in the Authorization header:

```bash theme={null}
Authorization: Bearer your_api_key_here
```

### Core APIs

<AccordionGroup>
  <Accordion icon="spider" title="Web Scraping API">
    Convert any webpage into clean markdown with our scraping endpoint.

    ```bash theme={null}
    curl -X POST https://api.norns.ai/v0/scrape \
      -H "Authorization: Bearer your_api_key" \
      -H "Content-Type: application/json" \
      -d '{"url": "https://example.com"}'
    ```

    The API returns the page content in markdown format along with metadata like title and description.
    Each scrape consumes 1 credit from your account.
  </Accordion>

  <Accordion icon="sitemap" title="Website Mapping API">
    Map entire websites and their structure with our mapping endpoint.

    ```bash theme={null}
    curl -X POST https://api.norns.ai/v0/map \
      -H "Authorization: Bearer your_api_key" \
      -H "Content-Type: application/json" \
      -d '{
        "url": "https://example.com",
        "limit": 100,
        "ignoreSitemap": false,
        "includeSubdomains": false
      }'
    ```

    Optional parameters:

    * `limit`: Maximum pages to crawl (1-5000)
    * `ignoreSitemap`: Skip sitemap parsing
    * `includeSubdomains`: Include subdomain pages
    * `sitemapOnly`: Only parse sitemap
    * `enrichLinks`: Add additional metadata to links

    Each mapping operation consumes 5 credits from your account.
  </Accordion>
</AccordionGroup>

## Usage Examples

<CardGroup>
  <Card title="Content Migration" icon="arrow-right-arrow-left">
    Use the scraping API to migrate content from an old website to a new platform while preserving formatting.
  </Card>

  {" "}

  <Card title="Site Analysis" icon="chart-network">
    Map your website's structure to understand content organization and identify
    broken links.
  </Card>

  {" "}

  <Card title="Content Indexing" icon="database">
    Create a searchable index of your website's content using our markdown output.
  </Card>

  <Card title="Documentation Tools" icon="book">
    Build documentation tools that can automatically extract and format web content.
  </Card>
</CardGroup>

## Error Handling

The API returns standard HTTP status codes:

* `400`: Bad Request (invalid parameters)
* `401`: Unauthorized (missing or invalid API key)
* `500`: Server Error

Common error responses include:

* Insufficient credits
* Invalid URL format
* Invalid JSON payload
* Missing required parameters

## Rate Limiting and Credits

* Each API call consumes credits from your account
* Scraping: 1 credit per request
* Mapping: 5 credits per request
* Monitor your credit usage in the dashboard
* Purchase additional credits as needed