Scrape Webpage

Scrape the url provided in the request body. Note that a session is automatically created and closed when the scrape is done.

If you need more control over the session creation (i.e proxy, etc.). You should manage the session manually and use the sessions/{session_id}/page/scrape endpoint.

/scrape

200

{
  "session": {
    "session_id": "<string>",
    "timeout_minutes": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z",
    "last_accessed_at": "2023-11-07T05:31:56Z",
    "duration": "<string>",
    "status": "active",
    "error": "<string>",
    "proxies": false,
    "browser_type": "chromium"
  },
  "data": {
    "markdown": "<string>",
    "images": [
      {
        "id": "<string>",
        "url": "<string>",
        "category": "icon"
      }
    ],
    "structured": {
      "success": true,
      "error": "<string>",
      "data": {}
    }
  }
}

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}