Run a deployment now
⚠️
Preview — this feature is being built; the design below is the spec.
POST https://app.syntic.ai/v1/deployments/{deployment_id}/runFire a deployment once, immediately, whatever its trigger type and even while paused. This is the only way a manual deployment fires.
For how this fits into a full workflow, see Scheduled and triggered runs.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <key>: a private inference key (sk_live_...). See Authentication. |
syntic-beta | Yes, while in preview | agents-2026-11-01. Without it the call fails with 400 beta_required. See Versioning. |
Content-Type | Yes | application/json |
Path parameters
| Parameter | Type | Description |
|---|---|---|
deployment_id | string | The deployment id, starting with dep_. |
Body parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
payload | object | No | Made available to the template as {{payload}}, up to 256 KB. |
Response
202 Accepted, Content-Type: application/json
{
"id": "drn_01JCA0B2D4F6H8K0M2P4",
"type": "deployment_run",
"fired_at": "2026-11-05T15:20:00Z",
"trigger_type": "manual",
"status": "started",
"session_id": "sesn_01JC9F2J4L6N8Q0S2U4W",
"skip_reason": null,
"error": null
}Examples
curl -sS https://app.syntic.ai/v1/deployments/dep_01JC9E2G4J6L8N0Q2S4U/run \
-H "Authorization: Bearer $SYNTIC_API_KEY" \
-H "syntic-beta: agents-2026-11-01" \
-H "Content-Type: application/json" \
-d '{
"payload": {
"reason": "re-run after data fix"
}
}'Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request_error | beta_required | The syntic-beta header is missing. |
| 404 | not_found_error | deployment_not_found | No deployment with that id in this workspace. |
| 409 | conflict_error | agent_archived | The agent is archived. |
| 401 | authentication_error | invalid_api_key | The key is missing, unknown, revoked or expired. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Related
Was this page helpful?