POST
/
v1
/
web
/
extract-json
Extract structured data from a web page
curl --request POST \
  --url https://api.weblinq.dev/v1/web/extract-json \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<string>",
  "waitTime": 0,
  "responseType": "json",
  "prompt": "<string>",
  "response_format": {
    "type": "json_schema",
    "json_schema": {}
  },
  "instructions": "<string>"
}'
{
  "success": true,
  "data": {
    "extracted": {},
    "text": "<string>",
    "metadata": {
      "url": "<string>",
      "timestamp": "<string>",
      "model": "<string>",
      "responseType": "json",
      "extractionType": "prompt",
      "fieldsExtracted": 123,
      "inputTokens": 123,
      "outputTokens": 123
    }
  },
  "creditsCost": 123,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Enter your API token or session token

Body

application/json

JSON extraction parameters

The body is of type object.

Response

200
application/json

JSON data extracted successfully

The response is of type object.