Trigger Schedule

Scheduler prerequisites

Configure an AgentOS-level database with schedule methods. The example scheduler server uses SQLite. Database-backed schedule CRUD is available without starting the scheduler; execution requires scheduler=True, a running application lifespan and a scheduler_base_url matching the server's address.

Owners come from authenticated identity. Configured authorization uses schedules:read, schedules:write and schedules:delete. Creating, repointing, enabling or triggering a run schedule also requires permission to run its target. Non-run targets require admin permission when that authorization is enforced. An inaccessible record can return 404; insufficient permission returns 403.

Manual trigger response

The schedule must be enabled (409 otherwise), and this process must have an executor (503 otherwise). Triggering requires target run permission when authorization is enforced.

The request awaits the executor's result. 200 can contain a schedule execution record with status="failed" or status="paused"; inspect that status rather than treating HTTP success as component completion. Use the returned record's id when reading schedule execution details.

POST/schedules/{schedule_id}/trigger

Authorization

HTTPBearer
AuthorizationBearer <token>

In: header

Path Parameters

schedule_id*Schedule Id

Response Body

application/json

application/json

curl --request POST 'https://example.com/schedules/string/trigger'
{  "id": "string",  "schedule_id": "string",  "user_id": "string",  "attempt": 0,  "triggered_at": 0,  "completed_at": 0,  "status": "string",  "status_code": 0,  "run_id": "string",  "session_id": "string",  "error": "string",  "input": {},  "output": {},  "requirements": [    {}  ],  "created_at": 0}