Skip to content

CreateSchedule ​

Type: object additionalProperties: false

FieldRequiredTypeDescription and constraints
profileNostringExact Orpheus profile name; creation uses the configured default when omitted. Every save except a pure pause requires an active profile and account. minLength: 1
templateNostringExact Orpheus template name; creation uses the configured default when omitted. minLength: 1
nameYesstringminLength: 1
maxLength: 200
promptYesstringminLength: 1
cronYesstringminLength: 1
timezoneYesstringminLength: 1
statusNoStatus
modelNostring / nullminLength: 1
session_modeNoSessionMode
owner_emailNostring / nullSAML non-admins must use their session email; omission fills it, explicit null is forbidden. Full-access callers may use any owner or null. minLength: 1
servicesNoServiceCodes

JSON Schema ​

json
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name",
    "prompt",
    "cron",
    "timezone"
  ],
  "properties": {
    "profile": {
      "type": "string",
      "minLength": 1,
      "description": "Exact Orpheus profile name; creation uses the configured default when omitted. Every save except a pure pause requires an active profile and account."
    },
    "template": {
      "type": "string",
      "minLength": 1,
      "description": "Exact Orpheus template name; creation uses the configured default when omitted."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "prompt": {
      "type": "string",
      "minLength": 1
    },
    "cron": {
      "type": "string",
      "minLength": 1
    },
    "timezone": {
      "type": "string",
      "minLength": 1
    },
    "status": {
      "$ref": "#/components/schemas/Status"
    },
    "model": {
      "type": "string",
      "nullable": true,
      "minLength": 1
    },
    "session_mode": {
      "$ref": "#/components/schemas/SessionMode"
    },
    "owner_email": {
      "type": "string",
      "nullable": true,
      "minLength": 1,
      "description": "SAML non-admins must use their session email; omission fills it, explicit null is forbidden. Full-access callers may use any owner or null."
    },
    "services": {
      "$ref": "#/components/schemas/ServiceCodes"
    }
  }
}

All schemas · HTTP API