Task Lifecycle Details
Use the following reference to shape your requests and interpret every response that the LLM Chat Scraper API returns during a task’s lifetime.
Common Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
actor | string | Yes | Fixed identifier that indicates which model you want to run. |
webhook | object | No | Object containing optional webhook settings. |
webhook.url | string | No | HTTPS endpoint that receives the result when the task finishes. |
input | object | Yes | Actor-specific parameters such as prompt, mode, or country. |
Result Data Structure
| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Task status: pending, running, success, or failed. |
message | string | No | Error message if the task fails. |
task_result | object | No | Full payload for the actor. See the actor docs for field-level details. |
Webhook Push Payload
If you set a webhook.url, Scrapeless issues a POST request with the following JSON shape:
| Parameter | Type | Required | Description |
|---|---|---|---|
task_id | string | Yes | Identifier of the completed task. |
status | string | Yes | success or failed. |
input | string | Yes | Original task parameters serialized as JSON. |
task_result | object | No | Same structure you would receive when polling the result endpoint. |
Push Example
curl --location '{webhook.url}' \
--header 'Content-Type: application/json' \
--data '{
"task_id": "",
"status": "",
"input": "",
"task_result": {}
}'HTTP Status Codes
| Status | Meaning |
|---|---|
200 | Success. The result has been retrieved. |
201 | Task created successfully. |
202 | Task still running—retry soon. |
400 | Invalid request. Inspect the error message for details. |
410 | Task result expired. Results remain available for 12 hours. |
429 | Rate limit exceeded. Reduce request frequency or upgrade capacity. |