Skip to main content
POST
/
schedules
{
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "<string>",
  "status": "online",
  "cron": "<string>",
  "inputs": {},
  "every": "<string>",
  "offset": "<string>",
  "start_at": "2023-11-07T05:31:56Z",
  "end_at": "2023-11-07T05:31:56Z",
  "timeout": 123,
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
fastapiusersauth
string
cookie
required

Query Parameters

​
workspace_id
string<uuid>
required

Body

application/json
​
workflow_id
required
​
inputs
object | null
​
cron
string | null

Cron expression for the schedule. Provide either cron or every.

​
every
string<duration> | null

ISO 8601 duration string. Provide either cron or every.

​
offset
string<duration> | null

ISO 8601 duration string

​
start_at
string<date-time> | null

ISO 8601 datetime string

​
end_at
string<date-time> | null

ISO 8601 datetime string

​
status
enum<string>
default:online
Available options:
online,
offline
​
timeout
number
default:0

The maximum number of seconds to wait for the workflow to complete

Response

Successful Response

​
owner_id
string<uuid>
required
​
every
string<duration>
required

ISO 8601 duration string

​
workflow_id
string<uuid>
required
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
id
string
​
status
string
default:online
​
cron
string | null
​
inputs
object
​
offset
string<duration> | null

ISO 8601 duration string

​
start_at
string<date-time> | null

ISO 8601 datetime string

​
end_at
string<date-time> | null

ISO 8601 datetime string

​
timeout
number | null

The maximum number of seconds to wait for the workflow to complete