Advanced
Extract (Beta)
Extract structured data from a URL based on a prompt and schema. Every request costs 10 credits.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/problem+json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/extract" \ -H "Content-Type: application/json" \ -d '{ "url": "http://example.com" }'{ "success": true, "extractParameters": { "url": "http://example.com" }, "results": null}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}