Skip to main content
POST
Create a paused canonical automation

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Headers

Idempotency-Key
string
required

Replay-protection key in an organization-wide namespace shared by keyed mutations. It must contain 1 to 256 visible ASCII characters and be sent as exactly one header value. Request identity is the exact HTTP method, escaped path, raw query, and raw body bytes. The same request replays the original successful response; any different request returns 409 idempotency_conflict, and an active matching request returns 409 idempotency_in_progress. Completed receipts are retained for approximately 24 hours, pending claims may be reclaimed after approximately 1 hour, and no deduplication is guaranteed after expiry.

Required string length: 1 - 256
Pattern: ^[!-~]+$

Body

application/json

Complete writable shape for creating or replacing a canonical automation.

agentId
string<uuid>
required

Managed agent selected by this automation.

agentVersionId
string<uuid>
required

Immutable agent version pinned for all admitted runs.

displayName
string
required

Human-readable automation name.

Required string length: 1 - 256
environmentId
string<uuid>
required

Execution environment selected for admitted sessions.

initialPrompt
object
required

Prompt definition frozen onto admitted runs.

Example:
runDefaults
object
required

Run defaults frozen onto admitted runs.

Example:
triggers
object[]
required

Complete trigger set for this automation aggregate.

Maximum array length: 20

Closed schedule-trigger configuration.

Example:

Response

Full round-trippable canonical automation aggregate.

Full round-trippable canonical automation aggregate.

agentId
string<uuid>
required

Managed agent selected by this automation.

agentVersionId
string<uuid>
required

Immutable agent version pinned for all admitted runs.

automationId
string<uuid>
required
read-only

Stable canonical automation identifier.

createdAt
string<date-time>
required
read-only

Time the automation was created.

displayName
string
required

Human-readable automation name.

environmentId
string<uuid>
required

Execution environment selected for admitted sessions.

initialPrompt
object
required

Prompt definition frozen onto admitted runs.

Example:
revision
integer<int64>
required
read-only

Monotonic aggregate revision represented by the response ETag.

Required range: x >= 1
runDefaults
object
required

Run defaults frozen onto admitted runs.

Example:
status
enum<string>
required
read-only

Lifecycle state. New automations start paused.

Available options:
paused,
active
triggers
object[]
required

Complete ordered trigger set.

Closed schedule-trigger configuration.

Example:
updatedAt
string<date-time>
required
read-only

Time the aggregate was last changed.