deployments

A deployment fires an agent on a schedule without a human at the terminal. Nine methods. API detail: Deployments.

create

client.deployments.create(body: DeploymentCreate): Promise<Deployment>

POST /v1/deployments. Requires agent_id, cron, and input_template; the rest of the deployment config is optional. agent_version pins the exact version this cron fires; timezone reads the cron expression.

const deploy = await client.deployments.create({
  agent_id: agent.id,
  cron: "0 9 * * MON",
  input_template: "Summarize last week's tickets",
});

list

client.deployments.list(query?: ListQuery): Promise<Page<Deployment>>

GET /v1/deployments, cursor-paginated.

get

client.deployments.get(id: string): Promise<Deployment>

GET /v1/deployments/{id}.

update

client.deployments.update(id: string, body: DeploymentPatch): Promise<Deployment>

PATCH /v1/deployments/{id}. DeploymentPatch is every config field optional except agent_id, which cannot be changed — repoint by creating a new deployment.

run

client.deployments.run(id: string): Promise<DeploymentRun>

POST /v1/deployments/{id}/run. Fire once, now — the “run it and see” verb. Does not touch the schedule.

runs

client.deployments.runs(id: string, query?: ListQuery): Promise<Page<DeploymentRun>>

GET /v1/deployments/{id}/runs — the history, each run pointing at the session it started.

pause / resume

client.deployments.pause(id: string): Promise<Deployment>
client.deployments.resume(id: string): Promise<Deployment>

POST /v1/deployments/{id}/pause and POST /v1/deployments/{id}/resume. Pausing stops the schedule; run still works while paused.

delete

client.deployments.delete(id: string): Promise<Deleted>

DELETE /v1/deployments/{id}. Past runs and their sessions remain readable.

TypeScript

Control plane

Resources

Identity & access

Automation

Account

create

list

get

update

run

runs

pause / resume

delete

​create

​list

​get

​update

​run

​runs

​pause / resume

​delete

create

list

get

update

run

runs

pause / resume

delete