Skip to main content
PATCH
/
scheduled-agents
/
{id}
Edit a scheduled agent
curl --request PATCH \
  --url https://origami.chat/api/v2/scheduled-agents/{id} \
  --header 'Authorization: Bearer <token>'
{
  "object": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "prompt": "<string>",
  "cron": "<string>",
  "model": "<string>",
  "enabled": true,
  "planBlocked": true,
  "nextRunAt": "2023-11-07T05:31:56Z",
  "lastRunAt": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "handoff": {}
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Response

200 - application/json

The updated scheduled agent.

​
object
string
required
Allowed value: "scheduled_agent"
​
id
string<uuid>
required
​
workspaceId
string<uuid>
required
​
slug
string
required
​
name
string
required
​
description
string | null
required
​
prompt
string
required
​
cron
string
required
​
model
string | null
required
​
enabled
boolean
required
​
planBlocked
boolean
required

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

​
nextRunAt
string<date-time> | null
required
​
lastRunAt
string<date-time> | null
required
​
url
string<uri>
required
​
handoff
object

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