v5

latestOpenAPI 3.1.02026-08-081,0211,3082.1 MB

AI_STUDIO

SCHEDULES

Update Schedule Endpoint

Update a schedule.

put/studio/schedules/{schedule_id}

Path parameters

schedule_idstring uuid required

Request body

namestring nullable

content_scope'first_query' | 'last_answer' | 'full_chat'

What content to include in the scheduled report.

frequency'daily' | 'weekly' | 'monthly' | 'custom'

Predefined schedule frequencies.

custom_cronstring nullable

hourinteger nullable

day_of_weekinteger nullable

Day of week for weekly frequency (0=Sunday … 6=Saturday). Only meaningful when the patched frequency is 'weekly'. When the patched frequency stays/becomes 'weekly' and this field is omitted, the existing weekday is preserved.

day_of_monthinteger nullable

Day of month for monthly frequency (1-31). Only meaningful when the patched frequency is 'monthly'.

emailsstring[] nullable

slack_webhook_idinteger nullable

enabledboolean nullable

Response

Successful Response

idstring uuid required

namestring required

session_idstring required

content_scope'first_query' | 'last_answer' | 'full_chat' required

What content to include in the scheduled report.

cron_exprstring required

destination_type'email' | 'slack' | 'multi' required

How to deliver the scheduled report.

Derived from destination_config at save time — MULTI means both emails and a Slack webhook are configured on the same schedule.

emailsstring[] required

slack_webhook_idinteger nullable

enabledboolean required

last_runstring date-time nullable required

next_runstring date-time nullable required

created_byinteger required

created_atstring date-time required

updated_atstring date-time required

day_of_weekinteger nullable

Cron weekday (0=Sunday … 6=Saturday) when frequency is weekly

day_of_monthinteger nullable

Cron day-of-month (1-31) when frequency is monthly