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

# POST /v1/batches

`POST /v1/batches`

## Request

- Base URL: `https://api.atlas-compiler.com`
- URL: `https://api.atlas-compiler.com/v1/batches`
- 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[]
  - `metadata` object
  - `projectId` string
  - `urls` string[], required
  - `webhook` union
    - string, uri
    - object
      - `events` string[]
      - `metadata` object
      - `url` string, uri, required
    - object
      - `endpointId` string, required

## Response `202`

Canonical job accepted.

- object
  - `artifactExpiresAt` string, date-time, nullable, required
  - `artifactState` 'not_applicable' | 'pending' | 'ingesting' | 'complete' | 'expired' | 'review', required
  - `cancellationRequestedAt` string, date-time, nullable, required
  - `createdAt` string, date-time, required
  - `executionTerminalAt` string, date-time, nullable, required
  - `id` string, required
  - `kind` 'compile' | 'crawl' | 'batch', required
  - `progress` object, nullable, required
    - `completedItems` integer, required
    - `etaSeconds` integer, nullable, required
    - `failedItems` integer, required
    - `queuedItems` integer, required
    - `ratePerMinute` integer, nullable, required
  - `projectId` string, nullable, required
  - `readyAt` string, date-time, nullable, required
  - `reviewReason` string, nullable, required
  - `status` 'queued' | 'running' | 'ingesting' | 'ready' | 'failed' | 'cancelled', required
  - `targetUrl` string, nullable
  - `updatedAt` string, date-time, required
  - `workspaceId` string, 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)