---
title: "POST /v1/scrape"
method: POST
path: "/v1/scrape"
tags: ["Execution"]
---

# POST /v1/scrape

`POST /v1/scrape`

## Request

- Base URL: `https://api.atlas-compiler.com`
- URL: `https://api.atlas-compiler.com/v1/scrape`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Headers

- `idempotency-key` string: Optional idempotency key. When provided, deduplicates requests within a 24-hour window.

## Request body

- object
  - `formats` string[]
  - `projectId` string
  - `url` string, uri, required

## Response `200`

Scraped result.

- object
  - `data` object, required
    - `ir` object
      - `contentGraph` object, required
        - `nodes` object, required
        - `readingOrder` string[], required
      - `metadata` object, required
        - `author` string
        - `canonicalUrl` string, required
        - `description` string
        - `documentHash` string
        - `extractionConfidence` number
        - `language` string
        - `publishedDate` string, date-time, nullable
        - `title` string, required
      - `version` string, required
    - `links` string[]
    - `markdown` string
  - `metadata` object, required
    - `author` string
    - `canonicalUrl` string, required
    - `description` string
    - `documentHash` string
    - `extractionConfidence` number
    - `language` string
    - `publishedDate` string, date-time, nullable
    - `title` string, required
  - `usage` object, required
    - `credits` integer, required

## Other responses

- `400`: RFC 9457 problem.
- `401`: RFC 9457 problem.
- `403`: RFC 9457 problem.
- `404`: RFC 9457 problem.
- `409`: RFC 9457 problem.
- `413`: RFC 9457 problem.
- `429`: RFC 9457 problem.
- `500`: RFC 9457 problem.
- `502`: RFC 9457 problem.
- `503`: RFC 9457 problem.

---

[API](https://skmtc.dev/atlas-compiler/apis/atlas-backend-api.md) · [All operations](https://skmtc.dev/atlas-compiler/apis/atlas-backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/atlas-compiler/apis/atlas-backend-api/revisions/a43b60619cdf?raw)