Create automation

Human-readable name for the automation.

Five-field cron expression (minute hour day month day-of-week) controlling when the automation fires. Seconds are not supported. The schedule must fire at most once every 15 minutes — finer-grained expressions are rejected with a 400 error.

The instruction text sent to the agent each time the automation fires. Supports Markdown. This is the agent's task for the run. Must not be empty or whitespace-only.

Optional free-text description of what this automation does.

Whether the automation should be active immediately after creation. Defaults to true when omitted or null. Set to false to create the automation in a paused state — it will not fire until explicitly enabled via the Update automation endpoint.

IANA timezone identifier in which cron is interpreted. Defaults to "UTC" when omitted.

Controls whether each scheduled run creates a fresh conversation thread or continues in the same persistent conversation.

• new_thread — (default) Each run starts a new conversation. Results are isolated; the agent has no memory of prior runs unless it uses agent memory tools.
• same_conversation — Every run appends to the same conversation thread. The agent sees the full history of prior runs, which is useful for incremental summaries or stateful workflows.

Where the automation's conversation runs and results are delivered.

• agent_dm — (default) Results are posted in the agent's own DM space. No destination_id is required.
• channel — Results are posted in a specific Datagrid channel. Provide the channel ID in destination_id.
• user_dm — Results are sent as a direct message to a specific user. Provide the user ID in destination_id.

The channel ID or user ID for the conversation destination. Required when destination_type is channel or user_dm; omit for agent_dm.

ID of an additional delivery channel (Slack, Teams, email, etc.) where the agent's output is also delivered after each run. Must be provided together with output_channel_type — supplying one without the other is rejected with a 400 error. This is an external transport address, not a Datagrid-owned resource — it's validated against the caller's own connected integrations at delivery time.

Transport type of output_channel_id. One of "email", "slack", "teams", "sms". Must be provided together with output_channel_id.

Controls when users are notified about automation run outcomes.

• always — Notify after every run regardless of success or failure. - on_failure — (default) Notify only when a run fails or produces an error.
• never — Do not send notifications for this automation.

The object type, always 'automation'.

Unique identifier for the automation.

Human-readable name of the automation.

Optional free-text description of what this automation does.

Whether the automation is active. When false the cron trigger is paused and no runs are scheduled until it is re-enabled.

ISO 8601 timestamp of when the automation was created.

Five-field cron expression controlling when the automation fires (e.g. "0 9 * * 1" = every Monday at 09:00). Seconds are not supported. Must have a minimum inter-fire interval of 15 minutes.

IANA timezone identifier in which cron is interpreted (e.g. "America/New_York", "UTC"). Defaults to "UTC" when not provided on create.

The instruction text sent to the agent each time the automation fires. Supports Markdown.

Controls whether each scheduled run creates a fresh conversation thread or continues in the same persistent conversation.

• new_thread — (default) Each run starts a new conversation. Results are isolated; the agent has no memory of prior runs unless it uses agent memory tools.
• same_conversation — Every run appends to the same conversation thread. The agent sees the full history of prior runs, which is useful for incremental summaries or stateful workflows.

ISO 8601 timestamp of the last modification.

Where the automation's conversation runs and results are delivered.

• agent_dm — (default) Results are posted in the agent's own DM space. No destination_id is required.
• channel — Results are posted in a specific Datagrid channel. Provide the channel ID in destination_id.
• user_dm — Results are sent as a direct message to a specific user. Provide the user ID in destination_id.

The channel ID or user ID that identifies the destination. Required when destination_type is channel or user_dm; omit for agent_dm.

ID of an additional delivery channel (Slack channel, Teams channel, email address, etc.) where automation results are also posted.

The transport type of the output channel. One of "email", "slack", "teams", "sms".

Controls when users are notified about automation run outcomes.

• always — Notify after every run regardless of success or failure. - on_failure — (default) Notify only when a run fails or produces an error.
• never — Do not send notifications for this automation.