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}/run

Fire 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

HeaderRequiredValue
AuthorizationYesBearer <key>: a private inference key (sk_live_...). See Authentication.
syntic-betaYes, while in previewagents-2026-11-01. Without it the call fails with 400 beta_required. See Versioning.
Content-TypeYesapplication/json

Path parameters

ParameterTypeDescription
deployment_idstringThe deployment id, starting with dep_.

Body parameters

ParameterTypeRequiredNotes
payloadobjectNoMade 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:

StatustypecodeWhen
400invalid_request_errorbeta_requiredThe syntic-beta header is missing.
404not_found_errordeployment_not_foundNo deployment with that id in this workspace.
409conflict_erroragent_archivedThe agent is archived.
401authentication_errorinvalid_api_keyThe key is missing, unknown, revoked or expired.
429rate_limit_errorrate_limitedToo many requests; wait for Retry-After. See Rate-limit headers.
Was this page helpful?