# Analyze (AI)



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

AI Content API analyzes any webpage and returns AI insights summary, value proposition, features, categories, use cases, and optional contact signals.

**Credit cost:** 1 credit per request

<APIPage document={"/repo/apps/docs/specs/openapi.json"} operations={[{"path":"/v1/analyze","method":"get"}]} />


# Capture (Screenshot)



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Browser-like Screenshot API that captures webpages as PNG/JPEG/WebP or PDF for previews, QA, reporting, monitoring, and archiving no headless setup.

**Credit cost:** 1 credit per request

<APIPage document={"/repo/apps/docs/specs/openapi.json"} operations={[{"path":"/v1/capture","method":"get"}]} />


# Content



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

CaptureKit Content API extracts structured webpage data, metadata, links, HTML/Markdown—in one request for SEO, monitoring, indexing and automation.

**Credit cost:** 1 credit per request

<APIPage document={"/repo/apps/docs/specs/openapi.json"} operations={[{"path":"/v1/content","method":"get"}]} />


# Credits



Each API call consumes credits from your account balance. The table below lists every endpoint and its cost.

<Callout type="info">
  You are only charged for successful requests (status code `200`). Failed requests do not consume credits.
</Callout>

| Endpoint                            | Method | Path                  | Credits |
| ----------------------------------- | ------ | --------------------- | ------- |
| [Analyze (AI)](/analyze)            | `GET`  | `/v1/analyze`         | 1       |
| [Capture (Screenshot)](/capture)    | `GET`  | `/v1/capture`         | 1       |
| [Content](/content)                 | `GET`  | `/v1/content`         | 1       |
| [Usage](/usage)                     | `GET`  | `/usage`              | —       |
| [Website Crawler](/website-crawler) | `GET`  | `/v1/website/crawler` | 1       |


# Introduction



Get started with the CaptureKit API in minutes. Make HTTP requests to our endpoints and receive structured JSON responses.

Quick Start [#quick-start]

<Steps>
  <Step>
    Get your API key [#get-your-api-key]

    Sign up on your [dashboard](https://app.capturekit.dev) and copy your API key from the **Settings** page.
  </Step>

  <Step>
    Make your first request [#make-your-first-request]

    Include your key in the `x-api-key` header and call any endpoint:

    ```bash
    curl "https://api.capturekit.dev/usage" \
      -H "x-api-key: YOUR_API_KEY"
    ```
  </Step>

  <Step>
    Handle the response [#handle-the-response]

    Every successful request returns a JSON object with structured data. See individual endpoint pages for response schemas and examples.
  </Step>
</Steps>

Authentication [#authentication]

All API requests must include an `x-api-key` header. You can find your key in your [dashboard settings](https://app.capturekit.dev/settings).

```bash
curl -H "x-api-key: xxxx" https://api.capturekit.dev/v1/usage
```

<Callout type="warn">
  Keep your API key secret. Do not expose it in client-side code or public repositories.
</Callout>

Status Codes [#status-codes]

Billing applies to successful requests: `200` for synchronous calls, `201` for asynchronous jobs, and `404` when the resource is not found (unless specified otherwise in the API documentation).

| Code  | Billed | Status              | Action                                                                                |
| ----- | ------ | ------------------- | ------------------------------------------------------------------------------------- |
| `200` | Yes    | Successful API Call | No action required.                                                                   |
| `201` | Yes    | Job Created         | No action required.                                                                   |
| `202` | No     | Accepted (Async)    | The request was accepted and is being processed. Use the job ID to check the status.  |
| `400` | No     | Bad Request         | Verify your parameters and their types. Check the documentation for more information. |
| `401` | No     | Invalid API Key     | Check your API key (`x-api-key` header or `x_api_key` query string).                  |
| `401` | No     | Inactive API Key    | Activate your API key in the API Keys section of your account settings.               |
| `401` | No     | Expired API Key     | Update your API key or generate a new one.                                            |
| `401` | No     | Rate Limit Exceeded | Consider upgrading your current plan or contact our sales team.                       |
| `402` | No     | Payment Required    | Settle any outstanding invoices to continue using the API.                            |
| `403` | No     | Forbidden           | Verify your permissions. Contact us if you believe this is a mistake.                 |
| `404` | Yes    | Not Found           | Result not found for this request. Some APIs do not bill 404.                         |
| `500` | No     | Internal Error      | Retry the action or contact our support team.                                         |

See the [Credits](/credits) page for a full breakdown of credit costs per endpoint.

Endpoints [#endpoints]

Browse all available endpoints in the sidebar, or jump directly:

<Cards>
  <Card title="Analyze (AI)" href="/analyze" />

  <Card title="Capture (Screenshot)" href="/capture" />

  <Card title="Content" href="/content" />

  <Card title="Usage" href="/usage" />

  <Card title="Website Crawler" href="/website-crawler" />
</Cards>


# Usage



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"/repo/apps/docs/specs/openapi.json"} operations={[{"path":"/usage","method":"get"}]} />


# Website Crawler



{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Website Crawler API fetches raw HTML from any webpage in request mode (no rendering) for fast scraping, audits, monitoring, and link/metadata extraction.

**Credit cost:** 1 credit per request

<APIPage document={"/repo/apps/docs/specs/openapi.json"} operations={[{"path":"/v1/website/crawler","method":"get"}]} />