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

# Overview

> How the Outcrawl API works.

export const OutcrawlStyles = () => {
  if (typeof document !== 'undefined' && !document.getElementById('outcrawl-overrides')) {
    const s = document.createElement('style');
    s.id = 'outcrawl-overrides';
    s.textContent = `
      /* Match the product's radius grid (4 / 6 / 8 / 9999), not Mintlify's default. */
      .rounded-sm { border-radius: 0.375rem !important; } /* 6px, --r-ctl */
      .rounded-md { border-radius: 0.375rem !important; } /* 6px, --r-ctl */
      .rounded-lg { border-radius: 0.5rem !important; }   /* 8px, --r-panel */
      .rounded-l-sm { border-top-left-radius: 0.375rem !important; border-bottom-left-radius: 0.375rem !important; }
      .rounded-r-sm { border-top-right-radius: 0.375rem !important; border-bottom-right-radius: 0.375rem !important; }
      .rounded-l-md { border-top-left-radius: 0.375rem !important; border-bottom-left-radius: 0.375rem !important; }
      .rounded-r-md { border-top-right-radius: 0.375rem !important; border-bottom-right-radius: 0.375rem !important; }
      .rounded-l-lg { border-top-left-radius: 0.5rem !important; border-bottom-left-radius: 0.5rem !important; }
      .rounded-r-lg { border-top-right-radius: 0.5rem !important; border-bottom-right-radius: 0.5rem !important; }

      /* Cards: never pure white in light mode, matching the one-big-card surface tone. */
      .card { background-color: #fcfcfc !important; border-radius: 0.5rem !important; }
      html.dark .card { background-color: #141311 !important; }

      /* Docs hero box */
      .oc-hero { background-color: #fcfcfc; border: 1px solid #e5e2dc; }
      html.dark .oc-hero { background-color: #141311; border-color: #26241f; }
      html.dark .oc-hero h1 { color: #edeae4; }

      /* Thin, transparent-track, hide-until-hover scrollbar. */
      ::-webkit-scrollbar { width: 6px; height: 6px; background-color: transparent; }
      ::-webkit-scrollbar-track { background-color: transparent; }
      ::-webkit-scrollbar-thumb { background-color: rgba(155, 155, 155, 0.5); border-radius: 10px; transition: opacity 0.3s ease; opacity: 0; }
      ::-webkit-scrollbar-thumb:hover { background-color: rgba(155, 155, 155, 0.7); }
      *:hover::-webkit-scrollbar-thumb,
      *:focus::-webkit-scrollbar-thumb,
      *:active::-webkit-scrollbar-thumb { opacity: 1; }
      * { scrollbar-width: thin; scrollbar-color: rgba(155, 155, 155, 0.5) transparent; }
    `;
    document.head.appendChild(s);
  }
  return null;
};

<OutcrawlStyles />

One base URL, one credential, every capability behind it. Unlike a platform with several surfaces and several keys, Outcrawl is one coherent API.

```
https://api.outcrawl.ai/v1
```

Every request is authenticated (see [authentication](/docs/api/authentication)) and every response carries a `usage` object stating exactly what that call cost, on the result that caused it, nothing appears on a bill that was not already visible on the request that produced it.

## Two framings

| Framing | Shape | Used by |
| - | - | - |
| `json` | One object | Everything by default |
| `ndjson` | A header frame, then zero or more item frames, one JSON object per line | `crawl` (always), `agent.events` (always) |

`agent` answers `json` unless the request sets `stream: true`. `sessions.get` answers `json` unless it sets `live: true`. Every other capability's framing is fixed.

## Errors

A failed request answers `{"code": "...", "message": "...", "details": {...}}`. Branch on `code`, never on `message`. See the [full 31-code table](/docs/api/errors).

## The capabilities

<CardGroup cols={3}>
  <Card title="Scrape" icon="file-text" href="/docs/scrape/overview">
    One URL in, clean content out
  </Card>

  <Card title="Crawl" icon="route" href="/docs/crawl/overview">
    Stream a whole site from a seed
  </Card>

  <Card title="Search" icon="search" href="/docs/search/overview">
    Results you can act on
  </Card>

  <Card title="Agents" icon="player-play" href="/docs/agents/overview">
    Hand over a task
  </Card>

  <Card title="Browsers" icon="device-desktop" href="/docs/browsers/overview">
    Live CDP control, TypeScript only
  </Card>

  <Card title="Monitors" icon="bell" href="/docs/monitors/overview">
    Watch a page, notify on change
  </Card>
</CardGroup>


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