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
Request Body
Parameters
Response
Check Status
Response - Pending
Response - Completed
Response Fields
Status Values
Batch Queue
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 asecret in the callback config, the response includes an HMAC signature:
Error Responses
Missing Idempotency Key
400 Bad Request
Token Expired
401 Unauthorized
Developer Budget Exhausted
402 Payment Required
Trigger Failed
503 Service Unavailable