The deployment object

⚠️

Preview — this feature is being built; the design below is the spec.

The deployment object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "dep_01JC9E2G4J6L8N0Q2S4U",
  "type": "deployment",
  "name": "daily-ticket-digest",
  "agent_id": "agt_01JC4R8W6Q2N9X3T5V7Y",
  "agent_version": null,
  "status": "active",
  "trigger": {
    "type": "schedule",
    "cron": "0 7 * * 1-5",
    "timezone": "Europe/London"
  },
  "input_template": "Summarise the support tickets opened on {{run.date_previous_day}}. Post the digest to #support-leads.",
  "session_options": {
    "memory_scope": "team:support",
    "limits": {
      "max_turns": 20
    }
  },
  "concurrency": "skip_if_running",
  "next_run_at": "2026-11-06T07:00:00Z",
  "last_run": {
    "id": "drn_01JC9F1H3K5M7P9R1T3V",
    "status": "succeeded",
    "session_id": "sesn_01JC9F2J4L6N8Q0S2U4W",
    "fired_at": "2026-11-05T07:00:00Z"
  },
  "created_at": "2026-11-01T12:00:00Z"
}

Fields

Field	Type	Description
`id`	string	Unique id of this object.
`type`	string	The object type, always `deployment`.
`name`	string	Name shown in the Console and in reports.
`agent_id`	string	The related agent.
`agent_version`	string or null	See the endpoint pages below.
`status`	string	Current state; see the values on the endpoint pages.
`trigger`	object	Nested detail; see the endpoint pages below.
`input_template`	string	See the endpoint pages below.
`session_options`	object	Nested detail; see the endpoint pages below.
`concurrency`	string	See the endpoint pages below.
`next_run_at`	string	See the endpoint pages below.
`last_run`	object	Nested detail; see the endpoint pages below.
`created_at`	string	When it was created, RFC 3339 UTC (some older objects use Unix seconds).

Returned by

data_residency deployment_run

Was this page helpful?