Skip to main content
POST
AI extract structured data from a web page

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