Automations API

workspace_id

query

UUID

Yes

is_active

query

boolean

category

query

string

trigger_type

query

string

source

query

string

limit

query

integer

offset

query

integer

id

UUID

name

string

display_name

string

description

string

icon

string

template_slug

string

workspace_id

UUID

trigger_type

string

cron or event.

cron_expression

string

event_patterns

list of string

prompt_template

string

prompt_parameters

object

custom_prompt_override

string

suggested_tools

list of string

max_steps

integer

model_override

string

post_to_chat

boolean

notify_on_findings

boolean

is_active

boolean

is_custom

boolean

Whether a user wrote the prompt rather than a template.

source

string

How it was created: template, custom, or conversation.

source_conversation_id

UUID

pack_instance_id

UUID

last_run_at

datetime

last_run_status

string

completed or failed for the latest finished run; empty if never run.

run_count

integer

consecutive_failures

integer

Failed runs in a row. At 5 the automation pauses; activating it resets this.

created_at

datetime

updated_at

datetime

workspace_id

UUID

Yes

template_slug

string

Yes

A template’s slug from GET /automations/templates/.

display_name

string

Yes

description

string

prompt_parameters

object

Values for the template’s parameters, keyed by name; missing ones use the template’s defaults.

trigger_type

string

cron to run on a schedule, event to run when a matching event happens.

cron_expression

string

Five-field cron schedule in UTC, such as 0 9 * * 1. Empty uses the template’s default schedule.

event_patterns

list of string

For event triggers: glob patterns on event names, such as datasource.*. Only data source events start automations.

post_to_chat

boolean

Post each run’s output and findings to a new chat conversation.

notify_on_findings

boolean

Notify the automation’s creator when a run finishes.

id

UUID

name

string

display_name

string

description

string

icon

string

template_slug

string

workspace_id

UUID

trigger_type

string

cron or event.

cron_expression

string

event_patterns

list of string

prompt_template

string

prompt_parameters

object

custom_prompt_override

string

suggested_tools

list of string

max_steps

integer

model_override

string

post_to_chat

boolean

notify_on_findings

boolean

is_active

boolean

is_custom

boolean

Whether a user wrote the prompt rather than a template.

source

string

How it was created: template, custom, or conversation.

source_conversation_id

UUID

pack_instance_id

UUID

last_run_at

datetime

last_run_status

string

completed or failed for the latest finished run; empty if never run.

run_count

integer

consecutive_failures

integer

Failed runs in a row. At 5 the automation pauses; activating it resets this.

created_at

datetime

updated_at

datetime

slug

string

display_name

string

description

string

category

string

icon

string

default_cron

string

parameter_count

integer

conversation_id

UUID

Yes

display_name

string

description

string

prompt_template

string

suggested_tools

list of string

parameters

list of object

workspace_id

UUID

Yes

conversation_id

UUID

Yes

The chat conversation the workflow comes from.

display_name

string

Yes

description

string

prompt_template

string

Yes

Instructions the agent follows on each run, with {{ parameter }} placeholders.

prompt_parameters

object

Values for the prompt’s {{ parameter }} placeholders, keyed by name.

suggested_tools

list of string

Tool names the agent should prefer; unknown names are ignored.

max_steps

integer

Stored with the automation; runs do not use it yet.

trigger_type

string

cron to run on a schedule, event to run when a matching event happens.

cron_expression

string

Five-field cron schedule in UTC, such as 0 9 * * 1.

post_to_chat

boolean

Post each run’s output and findings to a new chat conversation.

notify_on_findings

boolean

Notify the automation’s creator when a run finishes.

id

UUID

name

string

display_name

string

description

string

icon

string

template_slug

string

workspace_id

UUID

trigger_type

string

cron or event.

cron_expression

string

event_patterns

list of string

prompt_template

string

prompt_parameters

object

custom_prompt_override

string

suggested_tools

list of string

max_steps

integer

model_override

string

post_to_chat

boolean

notify_on_findings

boolean

is_active

boolean

is_custom

boolean

Whether a user wrote the prompt rather than a template.

source

string

How it was created: template, custom, or conversation.

source_conversation_id

UUID

pack_instance_id

UUID

last_run_at

datetime

last_run_status

string

completed or failed for the latest finished run; empty if never run.

run_count

integer

consecutive_failures

integer

Failed runs in a row. At 5 the automation pauses; activating it resets this.

created_at

datetime

updated_at

datetime

automation_id

path

UUID

Yes

id

UUID

name

string

display_name

string

description

string

icon

string

template_slug

string

workspace_id

UUID

trigger_type

string

cron or event.

cron_expression

string

event_patterns

list of string

prompt_template

string

prompt_parameters

object

custom_prompt_override

string

suggested_tools

list of string

max_steps

integer

model_override

string

post_to_chat

boolean

notify_on_findings

boolean

is_active

boolean

is_custom

boolean

Whether a user wrote the prompt rather than a template.

source

string

How it was created: template, custom, or conversation.

source_conversation_id

UUID

pack_instance_id

UUID

last_run_at

datetime

last_run_status

string

completed or failed for the latest finished run; empty if never run.

run_count

integer

consecutive_failures

integer

Failed runs in a row. At 5 the automation pauses; activating it resets this.

created_at

datetime

updated_at

datetime

automation_id

path

UUID

Yes

display_name

string

description

string

icon

string

A Heroicons icon name, such as bolt.

prompt_template

string

Instructions the agent follows on each run, with {{ parameter }} placeholders. Cannot be changed on template-based automations.

prompt_parameters

object

Values for the prompt’s {{ parameter }} placeholders, keyed by name.

custom_prompt_override

string

A full prompt that replaces the filled-in template. Empty uses the template.

suggested_tools

list of string

Tool names the agent should prefer; unknown names are ignored.

max_steps

integer

Stored with the automation; runs do not use it yet.

model_override

string

AI model for runs, as model-name or provider:model-name. Empty uses the default.

trigger_type

string

cron to run on a schedule, event to run when a matching event happens.

cron_expression

string

Five-field cron schedule in UTC, such as 0 9 * * 1.

event_patterns

list of string

For event triggers: glob patterns on event names, such as datasource.*. Only data source events start automations.

post_to_chat

boolean

Post each run’s output and findings to a new chat conversation.

notify_on_findings

boolean

Notify the automation’s creator when a run finishes.

id

UUID

name

string

display_name

string

description

string

icon

string

template_slug

string

workspace_id

UUID

trigger_type

string

cron or event.

cron_expression

string

event_patterns

list of string

prompt_template

string

prompt_parameters

object

custom_prompt_override

string

suggested_tools

list of string

max_steps

integer

model_override

string

post_to_chat

boolean

notify_on_findings

boolean

is_active

boolean

is_custom

boolean

Whether a user wrote the prompt rather than a template.

source

string

How it was created: template, custom, or conversation.

source_conversation_id

UUID

pack_instance_id

UUID

last_run_at

datetime

last_run_status

string

completed or failed for the latest finished run; empty if never run.

run_count

integer

consecutive_failures

integer

Failed runs in a row. At 5 the automation pauses; activating it resets this.

created_at

datetime

updated_at

datetime

automation_id

path

UUID

Yes

automation_id

path

UUID

Yes

id

UUID

name

string

display_name

string

description

string

icon

string

template_slug

string

workspace_id

UUID

trigger_type

string

cron or event.

cron_expression

string

event_patterns

list of string

prompt_template

string

prompt_parameters

object

custom_prompt_override

string

suggested_tools

list of string

max_steps

integer

model_override

string

post_to_chat

boolean

notify_on_findings

boolean

is_active

boolean

is_custom

boolean

Whether a user wrote the prompt rather than a template.

source

string

How it was created: template, custom, or conversation.

source_conversation_id

UUID

pack_instance_id

UUID

last_run_at

datetime

last_run_status

string

completed or failed for the latest finished run; empty if never run.

run_count

integer

consecutive_failures

integer

Failed runs in a row. At 5 the automation pauses; activating it resets this.

created_at

datetime

updated_at

datetime

automation_id

path

UUID

Yes

id

UUID

name

string

display_name

string

description

string

icon

string

template_slug

string

workspace_id

UUID

trigger_type

string

cron or event.

cron_expression

string

event_patterns

list of string

prompt_template

string

prompt_parameters

object

custom_prompt_override

string

suggested_tools

list of string

max_steps

integer

model_override

string

post_to_chat

boolean

notify_on_findings

boolean

is_active

boolean

is_custom

boolean

Whether a user wrote the prompt rather than a template.

source

string

How it was created: template, custom, or conversation.

source_conversation_id

UUID

pack_instance_id

UUID

last_run_at

datetime

last_run_status

string

completed or failed for the latest finished run; empty if never run.

run_count

integer

consecutive_failures

integer

Failed runs in a row. At 5 the automation pauses; activating it resets this.

created_at

datetime

updated_at

datetime

automation_id

path

UUID

Yes

run_id

UUID

status

string

automation_id

path

UUID

Yes

limit

query

integer

id

UUID

automation_id

UUID

task_execution_id

UUID

trigger_type

string

What started the run: cron, event, or manual.

trigger_event

string

The event that started the run; empty otherwise.

prompt_snapshot

string

The prompt exactly as the run used it.

output

string

The run’s written result.

findings

list of object

Issues the run recorded, each with severity (critical, warning, info), title, impact, and action.

tool_calls

list of object

token_usage

object

duration_ms

integer

conversation_id

UUID

status

string

pending, running, or waiting while in progress; then completed, failed, timed_out, cancelled, or dlq (retries used up).

error_message

string

created_at

datetime

updated_at

datetime

automation_id

path

UUID

Yes

run_id

path

UUID

Yes

id

UUID

automation_id

UUID

task_execution_id

UUID

trigger_type

string

What started the run: cron, event, or manual.

trigger_event

string

The event that started the run; empty otherwise.

prompt_snapshot

string

The prompt exactly as the run used it.

output

string

The run’s written result.

findings

list of object

Issues the run recorded, each with severity (critical, warning, info), title, impact, and action.

tool_calls

list of object

token_usage

object

duration_ms

integer

conversation_id

UUID

status

string

pending, running, or waiting while in progress; then completed, failed, timed_out, cancelled, or dlq (retries used up).

error_message

string

created_at

datetime

updated_at

datetime

slug

string

display_name

string

description

string

category

string

icon

string

template_count

integer

workspace_id

UUID

Yes

pack_slug

string

Yes

display_name

string

Yes

shared_parameters

object

per_template

object

id

UUID

pack_slug

string

pack_version

string

display_name

string

workspace_id

UUID

shared_parameters

object

automation_ids

list of UUID

created_at

datetime

updated_at

datetime

workspace_id

query

UUID

Yes

id

UUID

pack_slug

string

pack_version

string

display_name

string

workspace_id

UUID

shared_parameters

object

automation_ids

list of UUID

created_at

datetime

updated_at

datetime

instance_id

path

UUID

Yes

id

UUID

pack_slug

string

pack_version

string

display_name

string

workspace_id

UUID

shared_parameters

object

automation_ids

list of UUID

created_at

datetime

updated_at

datetime

target_type

string

Yes

What is scheduled: datasource or automation.

target_id

UUID

Yes

The data source or automation ID.

task_type

string

Yes

datasource.sync or automation.run; one schedule per target and task type.

cron_expression

string

Yes

Five-field cron schedule in UTC, such as 0 6 * * *.

metadata

object

id

UUID

target_type

string

target_id

UUID

task_type

string

cron_expression

string

is_active

boolean

last_dispatched_at

datetime

next_run_at

datetime

metadata

object

created_at

datetime

updated_at

datetime

target_type

path

string

Yes

target_id

path

UUID

Yes

id

UUID

target_type

string

target_id

UUID

task_type

string

cron_expression

string

is_active

boolean

last_dispatched_at

datetime

next_run_at

datetime

metadata

object

created_at

datetime

updated_at

datetime

target_type

path

string

Yes

target_id

path

UUID

Yes

task_type

path

string

Yes

schedule_id

path

UUID

Yes

id

UUID

target_type

string

target_id

UUID

task_type

string

cron_expression

string

is_active

boolean

last_dispatched_at

datetime

next_run_at

datetime

metadata

object

created_at

datetime

updated_at

datetime

schedule_id

path

UUID

Yes

id

UUID

target_type

string

target_id

UUID

task_type

string

cron_expression

string

is_active

boolean

last_dispatched_at

datetime

next_run_at

datetime

metadata

object

created_at

datetime

updated_at

datetime