API keys

An API key is a long-lived credential for your own applications and scripts. It is not the only bearer credential the API accepts, an OAuth access token from signing in also works, see API authentication for both and when to use which.

ock_YOUR_KEY_ID.YOUR_SECRET

Generate and revoke keys from https://outcrawl.ai/console/keys. A new key is shown once, at creation, copy it immediately. Set the key once in the environment:

export OUTCRAWL_API_KEY=ock_YOUR_KEY_ID.YOUR_SECRET

Then call the API with it:

import { Outcrawl } from '@outcrawl/sdk';

const oc = new Outcrawl(); // reads OUTCRAWL_API_KEY
const doc = await oc.scrape('https://example.com');
console.log(doc.markdown);

import asyncio
from outcrawl import Outcrawl

async def main() -> None:
    async with Outcrawl() as oc:  # reads OUTCRAWL_API_KEY
        doc = await oc.scrape("https://example.com")
        print(doc.markdown)

asyncio.run(main())

curl https://api.outcrawl.ai/v1/scrape \
  -H "Authorization: Bearer ock_YOUR_KEY_ID.YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

Both official SDKs read OUTCRAWL_API_KEY from the environment. The CLI reads it too, and it takes priority over a stored outcrawl login session, which is what makes it the right choice for CI and any headless environment where nobody can click through a sign-in page.

Welcome

SDKs

CLI

API

Scrape

Crawl

Search

Browsers

Agents

Monitors

Account

Billing

FAQ