Scheduled Tasks

Create a scheduled task.

post/scheduled_tasks

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/post.ts
A function with typed inputs. Its response is checked against the schema.

namestring required

descriptionstring

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

schedule_expressionstring required

ISO-8601 datetime for once, 5-field cron for recurring, "N minutes"/"N hours" for interval.

task_type'chat_completion' | 'agent_task' required

task_configobject required

Must contain a non-empty "message" key (the question/prompt). May include "timezone", "collection_id", "llm_args".

max_executionsinteger nullable

expires_atstring date-time nullable

notification_emailstring

Created

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

notification_emailstring

No recorded changes to this operation across all 1 revision of this API.