ORorigami
Scheduled agents

Create a scheduled agent (disabled by default)

Changed on

Requires name/prompt/cron. workspaceId is optional/nullable (a deprecated container anchor), not required. Invalid cron → INVALID_CRON / CRON_TOO_FREQUENT.

post/scheduled-agents

Request

  • Base URL
    https://origami.chat/api/v2
  • URL
    https://origami.chat/api/v2/scheduled-agents
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

Transport-level replay protection: any v2 POST may send it (1-255 printable ASCII characters; UUIDs recommended). The first response for a key is recorded and replayed verbatim for retries with the same key + method/path/body for 24 hours; replayed responses carry the Idempotency-Replay: true response header. Reusing a key with a different request, or retrying while the original is still in flight, returns 409 IDEMPOTENCY_ERROR. 5xx responses are never recorded (the retry re-executes).

Request body

namestring required
promptstring required
cronstring required

A cron expression.

workspaceIdstring uuid nullable

Deprecated container anchor; optional.

enabledboolean
descriptionstring nullable
modelstring nullable
budgetCreditsinteger nullable

Hard per-run credit cap (whole credits); each run stops spending once it hits it. Omit or null for no cap.

slugstring

Response

The created scheduled agent.

object'scheduled_agent' required
idstring uuid required
workspaceIdstring uuid nullable required

Deprecated container anchor - the legacy workspace, else the origin chat session whose links seed each run; null for container-less agents.

slugstring required
namestring required
descriptionstring nullable required
promptstring required
cronstring required
modelstring nullable required
enabledboolean required
budgetCreditsinteger nullable required

Hard per-run credit budget (whole credits). Each run of this agent is capped at this many credits and stops spending once it hits it. Null means no cap. Size it to comfortably cover the leads a run is expected to fetch (cost-per-lead × expected leads, plus margin).

planBlockedboolean required

True when the org cannot currently run scheduled tasks (gated at dispatch).

nextRunAtstring date-time nullable required
lastRunAtstring date-time nullable required
urlstring uri required
handoffobject

Present when planBlocked; points the caller at the upgrade flow.

Changes

  • 8c6b16fe0a3bRevision changes
    • breaking

      added required request body

    • breaking

      the response property became nullable for the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      response property workspaceId deprecated

    • info

      added the required property to the response with the status