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

Authorizations

​
Authorization
string
header
required

Enter your API token or session token

Body

application/json

AI extract parameters

​
url
string<uri>
required
​
waitTime
integer
default:0
Required range: 0 <= x <= 5000
​
responseType
enum<string>
default:json
Available options:
json,
text
​
prompt
string
Required string length: 1 - 1000
​
response_format
object
​
instructions
string
Maximum string length: 500

Response

AI extract completed successfully

​
success
enum<boolean>
required
Available options:
true
​
data
object
required
​
requestId
string<uuid>
required

Unique request identifier for tracing

​
timestamp
string<date-time>
required

ISO timestamp when the response was generated

​
creditsCost
number

Credits consumed by this operation