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

# POST /v1/compile

`POST /v1/compile`

## Request

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

## Headers

- `idempotency-key` string, required: Deduplicates only after current authentication and authorization succeed. Demotion or revocation can make replay unavailable.

## Request body

- object
  - `projectId` string
  - `url` string, uri, required

## Response `200`

Compiled result.

- object
  - `ir` object, required
    - `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
  - `markdown` 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
  - `usage` object, required
    - `credits` integer, required

## Other responses

- `202`: Canonical job accepted.
- `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)
