Skip to main content
POST
Create a task

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Replo-Api-Version
enum<string>
required

The public API version to use for this request.

Available options:
2026-10-29

Body

application/json
title
string
required

Short human-readable title for the task.

Required string length: 1 - 255
prompt
string
required

The exact prompt the task should run. This must be self-contained and executable without asking the user follow-up questions. Include any reasonable assumptions needed to complete the task, and do not include instructions like 'ask the user' or 'wait for clarification'.

Minimum string length: 1
scheduledAt
string<date-time>
required

ISO 8601 date-time with an explicit timezone offset when the task should first run. Must be in the future.

projectId
string<uuid>
required
emoji
string
default:✨

Emoji label used to visually group this task in the schedule UI.

Required string length: 1 - 8
rrule
string
default:FREQ=DAILY;COUNT=1

RRULE string for recurrence, such as FREQ=DAILY. Use FREQ=DAILY;COUNT=1 for one-time tasks.

Minimum string length: 1
delivery
object

Where each run's results go, e.g. { email: { recipients: ["me@brand.com"] } }. When the user wants results delivered, default to their own address. { email: { recipients: [] } } turns email off; omitting it on update keeps the current delivery.

recipeId
string

Id of the task recipe this task is based on, when the user picked one; its sample email becomes the run's layout guideline.

Required string length: 1 - 80

Response

Create a task

object
enum<string>
required
Available options:
task
id
string<uuid>
required
title
string
required
emoji
string
required
rrule
string
required
nextRunAt
string | null
required
pausedAt
string | null
required

When the task was paused; paused tasks don't run.

delivery
object | null
required

Where each run's results go.

createdAt
string
required
updatedAt
string
required