Run a schedule now
POST
Runs one of the serving version's schedules once, now, to test it. It calls the same endpoint the same way a scheduled run does, under its own run key, and is recorded as a manual run: it is not retried and does not move the schedule's own clock. It is billed as a request like any run. Refused with 409 not_published when no version with a schedule is serving.
Requires an API key with the workspace:write scope.
apiKeyheader
AuthorizationBearer <token>A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.
id*stringThe agent id.
name*stringThe schedule name from the manifest.
The run, as recorded
application/json- response
run*curl -X POST "https://api.vlayers.ai/v1/agents/$AGENT_ID/schedules/$SCHEDULE/run" \ -H "Authorization: Bearer $VOICELAYER_API_KEY"Example Response
{ "run": { "schedule": "daily-digest", "fireAt": "2026-10-20T15:04:05.000Z", "runKey": "sched:0192f5c2-6f7a-7b9c-8d1e-2f3a4b5c6d78:daily-digest:2026-10-20T15:04:05.000Z", "status": "done", "attempts": 1, "reason": null, "httpStatus": 200, "startedAt": "2026-10-20T15:04:05.000Z", "endedAt": "2026-10-20T15:04:05.000Z", "manual": false }}