Skip to main content
POST
Create automation

Authorizations

Authorization
string
header
required

API key authentication via Bearer token

Body

application/json
name
string
required
Example:

"Auto-reply to inquiries"

instructions
string
required
Example:

"When a new message is received, reply to the sender thanking them for their inquiry and let them know we will respond within 24 hours."

description
string
Example:

"Sends an auto-reply to new inquiries"

triggerEvent
string

The event type that triggers the automation. Optional - if omitted, a placeholder value is used and the LLM will infer the actual event type from instructions during evaluation.

Example:

"message.received"

triggerType
enum<string>

Whether this automation is event-driven or scheduled. Optional - will be inferred from instructions if not provided.

Available options:
event,
scheduled
Example:

"event"

cronExpression
string
Example:

"0 9 * * MON-FRI"

condition
object
enabled
boolean
Example:

true

groupId
string<uuid>
Example:

"123e4567-e89b-12d3-a456-426614174000"

groupName
string
Example:

"Customer Support"

groupMetadata
object
maxExecutions
integer
Example:

100

currentExecutions
integer
Required range: x >= 0
Example:

0

expiresAt
string<date-time>
Example:

"2025-12-31T23:59:59Z"

status
enum<string>

The status of the automation

Available options:
draft,
pending_evaluation,
evaluation_failed,
code_generation_failed,
pending_approval,
active,
paused,
completed,
expired,
failed,
archived
Example:

"draft"

Response

Automation created successfully

data
object
required
meta
object
Last modified on August 9, 2026