Getting Started

Interacting with the LLM Chat Scraper API always involves two simple steps: create a task for a specific actor and then fetch the result when it is ready.

Step 1: Create a Task

Send a POST request to /api/v2/scraper/request (or /api/v2/scraper/request for direct execution) with the actor-specific payload. When you include a webhook.url, Scrapeless will automatically push the finished result to that endpoint so you do not have to poll.

Request Example

curl '{api_host}/api/v2/scraper/request' \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: {you_api_key}' \
  --data '{
    "actor": "scraper.chatgpt",
    "input": {
      "prompt": "Most reliable proxy service for data extraction",
      "country": "US",
      "web_search": true
    },
    "webhook": {
      "url": "http://www.youwebhook.com"
    }
  }'

Step 2: Retrieve the Result

Results are retained for 5 minutes after completion. Fetch them quickly with the task_id returned from the creation call, or rely on your webhook receiver if you configured one in the previous step.

Request Example

curl --request GET '{api_host}/api/v2/scraper/result/{task_id}' \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: {you_api_key}'

Introduction Task Lifecycle