For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETList schedules
      • POSTCreate a schedule
      • GETGet results for a batch execution
      • GETList all schedule runs
      • GETGet results for a scheduled run
      • GETGet schedule sparklines
      • GETGet a schedule
      • PUTUpdate a schedule
      • DELDelete a schedule
      • POSTPause a schedule
      • POSTResume a schedule
      • POSTRun a schedule immediately
      • GETList runs for a schedule
      • GETGet schedule statistics
Dashboard
LogoLogo
Runtype APISchedules

Run a schedule immediately

POST
/v1/schedules/:id/run-now
POST
/v1/schedules/:id/run-now
$curl -X POST https://api.runtype.com/v1/schedules/id/run-now \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "batchExecutionId": "b7f3c9d2-4a1e-4f8a-9c3e-2d5a7f8b9e12",
3  "error": null,
4  "runId": "a1d2e3f4-5678-90ab-cdef-1234567890ab",
5  "status": "queued"
6}
Triggers an immediate execution of a schedule, bypassing its normal trigger timing.
Was this page helpful?
Previous

List runs for a schedule

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Response

Run triggered
batchExecutionIdstring or null
errorstring or null
runIdstring or null
statusenum
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error