Skip to main content
POST
Ask the host's clock to start work nobody will be present for

Authorizations

Authorization
string
header
required

Enforced on every transport, with no exempt operation. A person's request must carry a JWT issued by the configured identity provider, which the host verifies itself against that issuer's key set: signature, issuer, expiry, and the person and organisation it names. Requests without a valid one receive 401 NRY-0011 — except a request with no token on a laptop's socket from the OS user the kernel names as the host's own, which is that machine's user.

Body

application/json

A schedule being asked for, in the words the caller has: the rule arrives as the strings a person typed and one parser reads them, so every surface refuses --every whenever in the same sentence. There is no owner field and its absence is the rule rather than an omission — the host writes the owner from its own identity.

prompt
string
required

What the fired session is asked to do. Required: a schedule with nothing to do starts a session at three in the morning and does nothing in it.

repository
string

Absolute path of the directory a fire runs in, required unless clone is given and refused (422) beside it. Somebody must have vouched for it already; one nobody has is refused with the sentence that names the gesture.

Maximum string length: 4096
agent
string

The agent recipe a fire runs under. Empty runs the host's default.

every
string

An interval — "15m", "2h", "24h", "7d". Exactly one of every and at is given. The shortest a schedule may fire on is five minutes, and anything under it is refused naming the floor: an agent turn takes minutes and spends money, so a schedule measured in seconds is an incident rather than an aggressive setting. An interval's first fire is one interval away, never immediately.

at
string

One absolute RFC3339 instant, fired once, after which the schedule is completed. An instant already behind the clock is refused rather than fired late.

ceilingUsd
number<double>

What one fire may spend. Absent takes the operator's configured default, which is why the spend ceiling is on whether or not anybody thought about it. Zero is not absent and is never promoted: it is a schedule that does not fire, which is how one is parked until somebody prices it.

Required range: x >= 0
environment
string

Run every fire inside this environment, which must already exist (createEnvironment) and is read again at each fire. Absent means the host's own machine on a person's own home, whose repository must exist there, and a container of each fire's own on a hosted home (createSession).

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*$
clone
string

A repository cloned afresh into each fire's own container, exactly as createSession's clone: on a hosted home, without environment, and the schedule's repository, which reads back as owner/name.

Maximum string length: 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*/[A-Za-z0-9][A-Za-z0-9._-]*$
setupScript
string

Run once at each fire in place of the clone's own .narya/setup.sh, as createSession's setupScript. Only with clone (422 otherwise).

Required string length: 1 - 65536
idempotencyKey
string

A key the client chooses for this schedule, so a create whose answer was lost can be repeated safely. A create carrying a key its caller already created a schedule under records nothing: it is answered 201 with that schedule, whatever else this body says. Absent, every create records a schedule.

Required string length: 1 - 255

Response

The schedule as stored, with the first instant it is owed.

Work the host's own clock starts, with nobody present. A schedule is durable configuration, never swept: what a fire produces is a session, governed by the rules sessions already have, while the schedule itself stays until somebody cancels it. The owner is never something a caller names — a fire has to be attributable to somebody who is not there, and an attribution the reader cannot check reads exactly like a true one.

id
string<uuid>
required
owner
string
required

Who this schedule's fires are billed to and attributed to: the person who created it, as the host authenticated them. A fire runs with nobody present, so this is read from the row rather than from whoever is signed in at the time — which is what lets a schedule outlive its author being away.

repository
string
required

The directory a fired session runs in, relative to the workspace on a hosted home. Somebody has vouched for it — creation refuses one nobody has — and the host reads that answer again at every fire, because trust is revocable.

prompt
string
required

What the fired session is asked to do.

rule
object
required

When a schedule fires: a kind and the one parameter that kind takes. Exactly one parameter is ever set. There is no cron expression here and the absence is a decision, not a gap: a cron expression drags a timezone, a daylight-saving policy and a no-match semantics behind it, and an agent turn costs money and takes minutes, so the units that matter are hours and days.

status
enum<string>
required

active fires; completed is what a single-instant schedule becomes once that instant is spent; cancelled is what a person does to one, and it stops the fires without removing the record; paused keeps the row and stops the fires, which is the difference between changing your mind and changing it back.

Available options:
active,
paused,
completed,
cancelled
ceilingUsd
number<double>
required

What ONE fire may spend. A hard stop on the turn rather than a price — see setScheduleBudget for what it does and does not bound. Zero means this schedule does not fire. A fire on a model this host has no price for runs without it, and notice says so.

Required range: x >= 0
createdAt
string<date-time>
required
runCount
integer
required

How many instants this schedule has CLAIMED, including fires that never reached a session. The count is incremented inside the same transaction that spends the instant, which is what makes a fire unrepeatable across a crash — so a fire refused after the claim, or a host that died in the gap before the session existed, is counted here and explained in lastError. A consumer counting SESSIONS wants the sessions themselves, not this.

Required range: x >= 0
agent
string

The agent recipe a fire runs under. Absent runs the host's default.

environment
string

The environment every fire runs inside, read again at each fire. Absent is a schedule whose fires run on the host's own machine, or on a hosted home in a container of each fire's own.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*$
clone
string

The repository cloned afresh into each fire's own container on a hosted home, which is also the schedule's repository.

nextRunAt
string<date-time>

The instant a fire is owed at. Absent once a single instant has been spent. A cancelled schedule KEEPS the instant it was going to run at — its status is what stops the fire, and the instant is what somebody reads when they wonder whether they stopped the right one. It is advanced from the moment of the fire rather than from the instant that was missed, which is why a host that was off for three days fires once rather than three times.

lastRunAt
string<date-time>

When this schedule last CLAIMED an instant. Absent until it has. It is stamped at the claim, before the fire's session exists, so it says when the host last acted on this schedule rather than when work last started: a fire refused for a missing repository or a missing key moves it too, and lastError says which.

lastFiredSessionId
string<uuid>

The session the last fire created, which is where the morning's reading starts. It may name a session that has since been purged.

lastSkippedAt
string<date-time>

When a due fire was refused, with lastSkipReason saying which refusal it was. Recorded rather than silent: a skip nobody can read is indistinguishable from a scheduler that stopped working. Written once while the refusal lasts, so it answers "since when", and cleared by any fire that gets through.

lastSkipReason
string
lastError
string

How a fire that had already claimed its instant failed to reach a session. The instant stays spent, so this is what the morning reads instead of an unexplained gap.

notice
string

What the last fire that opened a session says about how this schedule's fires run, absent when it says nothing. Two facts earn it: the model the fires run on has no price on this host, so they run with no spend ceiling until a fire on a priced model clears it; or the agent they run comes from the repository each fire's turn clones, so its price is judged when the turn clones and a priced model keeps the ceiling.