Skip to content

Start Task

Method: POST

Endpoint: /api/v1/task/run

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

POST/api/v1/task/runStart saved task run
Required

Stored only in this browser tab. Sent only to https://openapi.coreclaw.com.

BodyRequiredapplication/json
FieldTypeRequiredDescription
task_slugstringyesUnique saved task identifier.
callback_urlstringyesWebhook URL for async completion callbacks.
Request body (JSON)

Use this endpoint when you already have a saved Task template and want to create a new run from that template.

task_slug is the Task ID — a unique identifier generated when you create and save a Task template. A Task is a reusable configuration that bundles a Worker with preset parameters.

Important: Do not pass a run_slug (Run Record ID) or scraper_slug (Worker ID) here. Each slug type serves a different purpose.

{
"task_slug": "YOUR_TASK_SLUG",
"callback_url": "https://your-callback.example.com/webhook"
}
ParameterExampleTypeRequiredDescription
task_slugYOUR_TASK_SLUGStringYesTask ID — unique identifier for the saved Task template
callback_urlhttps://your-callback.example.com/webhookStringYesCallback URL for receiving Task run results
{
"code": 0,
"message": "success",
"data": {
"run_slug": "01KSFDS8XWTJME33C08XMCR6B9"
}
}
ParameterExampleTypeDescription
code0IntegerGlobal status code
messagesuccessStringResponse message
data-ObjectResponse payload
run_slug01KSFDS8XWTJME33C08XMCR6B9StringRun Record ID — unique identifier for this execution
  • callback_url is required. Omitting it returns 400 Bad Request.
  • Do not pass a run_slug (Run Record ID) or scraper_slug (Worker ID) instead of a valid task_slug — each slug type is different and not interchangeable.

Business-level errors may return a structured JSON body such as:

{
"code": 60001,
"message": "Task does not exist",
"data": null
}
ParameterExampleTypeDescription
code60001IntegerError code
messageTask does not existStringError description
datanullNullEmpty payload