WorkflowSchedule

Workflow schedule configuration

Properties

Property	Type	Required	Description
`workflow_id`	`string`	✅ Yes	Unique workflow identifier
`enabled`	`boolean`	❌ No	Whether workflow is active
`frequency`	`string`	✅ Yes	Execution frequency
`schedule_time`	`object`	❌ No	Specific time for execution (e.g., '09:00')
`timezone`	`string`	❌ No	Timezone for schedule

Example

{
  "workflow_id": "example",
  "enabled": false,
  "frequency": "hourly",
  "schedule_time": {},
  "timezone": "example"
}

Used In

POST /workflows/schedule

Code Examples

TypeScript

interface WorkflowSchedule {
  workflow_id: string;
  enabled?: boolean;
  frequency: 'hourly' | 'daily' | 'weekly' | 'monthly';
  schedule_time?: any;
  timezone?: string;
}
 
// Usage example
const data: WorkflowSchedule = {
  "workflow_id": "example",
  "enabled": false,
  "frequency": "hourly",
  "schedule_time": {},
  "timezone": "example"
};

Python

from data_layer.schemas import WorkflowSchedule
 
# Create instance
data = WorkflowSchedule(
    # Add your field values here
)

cURL

curl -X POST "https://altsportsleagues-backend-2qcdjegnaa-uc.a.run.app/api/endpoint" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{   "workflow_id": "example",   "enabled": false,   "frequency": "hourly",   "schedule_time": {},   "timezone": "example" }'

Validation Rules

Required Fields: workflow_id, frequency

frequency: Must be one of: hourly, daily, weekly, monthly

Additional Information

Type: object
Source: Generated from Pydantic models in data_layer/schemas/
Auto-validated: All fields are validated by FastAPI

This documentation is auto-generated from the OpenAPI specification.

WorkflowExecution YouTubeExtractRequest