Skip to main content
POST
Create scheduled task

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
workspaceId
string
required

Workspace id from list_workspaces.

Required string length: 1 - 64
agentId
string
required

Agent id from list_agents; the agent must belong to the workspace.

Required string length: 1 - 64
prompt
string
required

What the agent should do on every run, written like a task for the agent.

Required string length: 1 - 20000
cron
string
required

Five-field cron in the organization's timezone (returned as timezone). Supported shapes: hourly 'M * * * *', daily 'M H * * *', weekdays 'M H * * 1-5', weekly 'M H * * D' (D 0-6, 0 = Sunday), monthly 'M H DOM * *' (DOM 1-31). Example: '0 9 * * 1-5' is 09:00 every weekday.

Required string length: 9 - 100
title
string

Short name for the task. Omit to have Whirl generate one.

Required string length: 1 - 200

Response

Success

The response is of type object.