ORorigami
Scheduled agents

Fetch a scheduled agent (+ planBlocked, last run)

Changed on
get/scheduled-agents/{id}

Request

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

Response

The 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

      the response property became nullable for the status

    • info

      response property workspaceId deprecated

    • info

      added the required property to the response with the status