Scheduled Tasks

Update a scheduled task (partial).

put/scheduled_tasks/{task_id}

Request

Base URL
https://h2ogpte.genai.h2o.ai/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/h2o/apis/h2ogpte-rest-api/docs/scheduled_tasks/:task_id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

task_idstring required

Request body

namestring

descriptionstring

schedule_type'once' | 'recurring' | 'interval'

schedule_expressionstring

task_type'chat_completion' | 'agent_task'

task_configobject

task_config_patchobject

Partial task_config update. Top-level keys are merged into the stored task_config; a key whose value is JSON null is REMOVED (e.g. {"collection_id": null} unbinds the collection). Nested objects are replaced whole, not deep-merged. Mutually exclusive with task_config. The merged result must keep a non-empty 'message'.

status'active' | 'paused' | 'completed' | 'expired'

max_executionsinteger nullable

expires_atstring date-time nullable

notification_emailstring

Response

idstring uuid

user_idstring uuid

usernamestring

namestring

descriptionstring

schedule_type'once' | 'recurring' | 'interval'

schedule_expressionstring

task_type'chat_completion' | 'agent_task'

task_configobject

status'active' | 'paused' | 'completed' | 'expired'

execution_statusstring

Runtime execution state: idle or running.

last_execution_atstring date-time nullable

next_execution_atstring date-time nullable

execution_countinteger

max_executionsinteger nullable

expires_atstring date-time nullable

created_atstring date-time

updated_atstring date-time

is_ownerboolean