Create a Batch job
POST
/v1/batch-jobsAdds work to the manual shelf or capacity-aware queue.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
None.
Query parameters
None.
Header parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| Idempotency-Key | header | string | No | — |
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Human-readable name. |
| description | string | No | Human-readable description. |
| targetKind | thread_run | metronome_run | evaluation_run | agent_optimization | project_ticket_action | Yes | — |
| targetResourceId | string | No | — |
| targetVersionId | string | No | — |
| definition | object | No | For thread_run, provide threadId (or targetResourceId) to resume an existing thread, or provide message to create a new thread when the Batch is released. New-thread definitions may also specify agentId, environmentId/computerId, projectId, title, attachments, enabledSkills, reasoningEffort, and cost boundaries. |
| startPolicy | manual | stay_on_shelf | when_capacity_available | No | manual is a one-shot shelf job started explicitly; stay_on_shelf is also started explicitly but returns to the bottom of its shelf after every successful execution; when_capacity_available is automatically released by the scheduler when runtime capacity permits. |
| queueLane | string | No | — |
| priority | integer | No | — |
| maxAttempts | integer | No | — |
| sourceProjectId | string | No | — |
| sourceTicketId | string | No | — |
| permissionSet | string | No | — |
| idempotencyKey | string | No | — |
| metadata | object | No | Free-form metadata object. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201Batch job createdapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| job | object | Yes | — |
| job.id | string | Yes | Unique identifier. |
| job.userId | string | Yes | User ID. |
| job.organizationId | string | No | — |
| job.createdByUserId | string | No | — |
| job.name | string | Yes | Human-readable name. |
| job.description | string | Yes | Human-readable description. |
| job.targetKind | thread_run | metronome_run | evaluation_run | agent_optimization | project_ticket_action | Yes | — |
| job.targetResourceId | string | No | — |
| job.targetVersionId | string | No | — |
| job.definition | object | Yes | Native target definition. A Thread Batch may reference an existing thread with threadId (or targetResourceId), or create a new thread when released by providing message and optional agentId, environmentId/computerId, projectId, title, attachments, skills, reasoning effort, and cost boundaries. |
| job.startPolicy | manual | stay_on_shelf | when_capacity_available | Yes | manual is a one-shot shelf job started explicitly; stay_on_shelf is also started explicitly but returns to the bottom of its shelf after every successful execution; when_capacity_available is automatically released by the scheduler when runtime capacity permits. |
| job.status | held | queued | dispatching | running | succeeded | failed | cancelled | Yes | Current lifecycle status. |
| job.queueLane | string | Yes | — |
| job.priority | integer | Yes | — |
| job.position | integer | Yes | — |
| job.maxAttempts | integer | Yes | — |
| job.attemptCount | integer | Yes | — |
| job.executionGeneration | integer | Yes | — |
| job.availableAt | string | Yes | — |
| job.waitReason | string | No | — |
| job.nativeResourceType | string | No | — |
| job.nativeResourceId | string | No | — |
| job.sourceProjectId | string | No | — |
| job.sourceTicketId | string | No | — |
| job.permissionSet | string | Yes | — |
| job.idempotencyKey | string | No | — |
| job.leaseOwner | string | No | — |
| job.leaseExpiresAt | string | No | — |
| job.heartbeatAt | string | No | — |
| job.lastError | string | No | — |
| job.metadata | object | Yes | Free-form metadata object. |
| job.createdAt | string | Yes | ISO 8601 timestamp. |
| job.updatedAt | string | Yes | ISO 8601 timestamp. |
| job.queuedAt | string | No | — |
| job.startedAt | string | No | ISO 8601 timestamp. |
| job.completedAt | string | No | ISO 8601 timestamp. |
| idempotentReplay | boolean | No | — |
400Invalid Batch definition
None.
503Durable control plane unavailable
None.