---
title: "Create Batch"
method: POST
path: "/v1/batches"
tags: ["extractions"]
---

# Create Batch

`POST /v1/batches`

## Request

- Base URL: `https://api.caelario.com`
- URL: `https://api.caelario.com/v1/batches`
- Auth: none declared

## Headers

- `Idempotency-Key` string, nullable
- `X-API-Key` string, nullable
- `X-Workspace-ID` string, nullable
- `authorization` string, nullable

## Request body

- BatchExtractionRequest: One operation applied to an ordered set of independent public targets.
  - `platform` string
  - `operation` 'profile' | 'followers' | 'following' | 'posts' | 'reels' | 'comments' | 'highlights' | 'highlight_items' | 'stories' | 'hashtag' | 'search' | 'search_users' | 'post' | 'video' | 'transcript' | 'comment_replies' | 'adlibrary_companies' | 'adlibrary_company_ads' | 'adlibrary_search' | 'adlibrary_ad' | 'adlibrary_ad_transcript' | 'profile_analytics' | 'tagged' | 'trending' | 'shorts' | 'playlist' | 'playlist_items', required
  - `targets` string[], required
  - `limit` integer
  - `include_posts` integer

## Response `202`

Successful Response

- BatchResponse
  - `id` string, required
  - `platform` string, required
  - `operation` string, required
  - `requested_limit` integer, required
  - `include_posts` integer
  - `target_count` integer, required
  - `status` string, required
  - `queued_count` integer, required
  - `running_count` integer, required
  - `completed_count` integer, required
  - `failed_count` integer, required
  - `cancelled_count` integer, required
  - `result_count` integer, required
  - `reserved_credits` integer, required
  - `billed_credits` integer, required
  - `cancel_requested_at` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `jobs` JobResponse[]
    - `id` string, required
    - `platform` string, required
    - `operation` string, required
    - `target` string, required
    - `requested_limit` integer, required
    - `include_posts` integer
    - `status` string, required
    - `attempts` integer, required
    - `max_attempts` integer, required
    - `progress_stage` string, required
    - `progress_message` string, nullable, required
    - `progress_current` integer, required
    - `progress_total` integer, nullable, required
    - `heartbeat_at` string, date-time, nullable, required
    - `next_attempt_at` string, date-time, nullable, required
    - `cancel_requested_at` string, date-time, nullable, required
    - `result_count` integer, nullable, required
    - `billed_units` integer, required
    - `credit_rate` integer, required
    - `results_per_credit` integer, required
    - `billed_credits` integer, required
    - `source_exhausted` boolean
    - `request_cursor` string, nullable
    - `next_cursor` string, nullable
    - `result` unknown
    - `error` unknown
    - `created_at` string, date-time, required
    - `started_at` string, date-time, nullable, required
    - `finished_at` string, date-time, nullable, required
    - `cached` boolean
    - `deduplicated` boolean
    - `idempotent_replay` boolean
  - `idempotent_replay` boolean

## Other responses

- `422`: Validation Error

---

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