Skip to content

Start Task

Method: POST

Endpoint: /api/v1/task/run

Send the request body with Content-Type: application/json.

{
"task_slug": "01KK0G4W9W4JYTWEA55KMG5QKP",
"callback_url": "https://your-domain.com/callback"
}
ParameterExampleTypeRequiredDescription
task_slug01KK0DS99CJG4ZEC11VDXZ8Y2QStringYesUnique task identifier
callback_urlhttps://your-domain.com/callbackStringYesCallback URL for receiving Task results
{
"code": 0,
"message": "success",
"data": {
"run_slug": "01KKDXV2G26BT7NH4ZQR2R4NPZ"
}
}
ParameterExampleTypeDescription
code0IntegerGlobal status code
messagesuccessStringResponse message
data-ObjectResponse payload
run_slug01KKDXV2G26BT7NH4ZQR2R4NPZStringUnique run identifier
{
"code": 70001,
"message": "Run record does not exist",
"data": null
}
ParameterExampleTypeDescription
code70001IntegerError code
messageRun record does not existStringError description
datanullNullEmpty payload