Skip to main content

Incubate API

The Incubate API enables async/deferred prompt execution with built-in concurrency limiting. Unlike the synchronous /prompt endpoint, incubate queues prompts for background execution with status tracking.
Use Incubate for background jobs, scheduled tasks, or when you need concurrency control per developer.

Concurrency Limits

Each developer gets a concurrency limit based on their subscription tier: Concurrency is enforced per-developer across all their projects using concurrencyKey.

Endpoints

Queue a Prompt

Queue a prompt for deferred execution.

Request Body

Parameters

Response

Check Status

Poll the status of a queued prompt.

Response - Pending

Response - Completed

Response Fields

Status Values

Batch Queue

Queue multiple prompts at once (max 100 items).

Request Body

Response

Callback Webhooks

When a callback is configured, results are POSTed to your URL upon completion.

Callback Request

HMAC Verification

If you provide a secret in the callback config, the response includes an HMAC signature:
Verify the signature:

Error Responses

Missing Idempotency Key

Status: 400 Bad Request

Token Expired

Status: 401 Unauthorized

Developer Budget Exhausted

Status: 402 Payment Required

Trigger Failed

Status: 503 Service Unavailable

Examples

cURL - Queue Prompt

cURL - Check Status

JavaScript - Queue and Poll

Python - With Callback

Comparison: /prompt vs /incubate