Skip to main content
GET
Fetch a scheduled agent (+ planBlocked, last run)

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

The 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.