Skip to main content
POST
Create workflow schedule

Authorizations

Authorization
string
header
required

Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.

Body

application/json
timezone
string
required
Example:

"Europe/Paris"

workflow_id
string<uuid>

The workflow to schedule — exactly one of workflow_id / prompt_id.

Example:

"4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641"

prompt_id
string<uuid>

One of the user's saved automations (GET /v1/prompts) to schedule instead of a workflow.

user_id
string

The user the runs execute as (billing group, integrations, result thread owner). Required with an API key; implied by a session token.

Example:

"user_4821"

group
object
recurrence
object
Example:
cron
string

Alternative to recurrence. Minimum interval: hourly.

Example:

"0 8 * * 1-5"

starts_at
string<date-time>
ends_at
string<date-time>
input
object
Example:
notify
enum<string>
default:thread
Available options:
thread,
none
thread_title
string
Example:

"Daily signups digest"

name
string

Response

The schedule, with its next run times

schedule
object
next_fires
string<date-time>[]
published_version
integer | null

Session + own workflow: the version the schedule runs (published by this call when the draft was newer).