Documentation by ClonePartner

Start typing to search.

API Reference

Trigger a task run

View Markdown
POST /api/runs/trigger/{taskId}

Creates a new run for the specified task and starts execution.

Operation IDtriggerRun

Authentication

  • BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

taskIdintegerrequired

Task ID to run

Request body

Content typeapplication/json

requestobject
2 properties
argumentsobject

Runtime arguments passed to the task

Additional properties are allowed.

connector_mappingobject

Map of connector slot name to connector ID

Additional properties
valueinteger

Success response body

201Run created and started

Run created and started

Content typeapplication/json

responseobject
16 properties
idinteger
task_idinteger
task_versioninteger
trigger_typestring
Allowed values
manual, cron, api
statusstring
Allowed values
pending, running, success, completed, failed, cancelled
argumentsstring | null

JSON-encoded arguments

Nullable
yes
connector_mappingstring | null

JSON-encoded map of connector slot name to connector ID

Nullable
yes
started_atstring | null · date-time
Nullable
yes
completed_atstring | null · date-time
Nullable
yes
duration_msinteger | null
Nullable
yes
item_countinteger | null
Nullable
yes
error_messagestring | null
Nullable
yes
log_filestring | null
Nullable
yes
metrics_summarystring | null
Nullable
yes
created_atstring · date-time
updated_atstring · date-time

Error responses

404Resource not found

Resource not found

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}