Extract
Start AI-powered data extraction job
POST
/extractAuthorization
api-key AuthorizationBearer <token>
Enter your API key with the bc_ prefix
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
urls?array<string>
URLs to extract data from
prompt*string
Natural language prompt describing what to extract
schema?
JSON Schema for structured output
enableWebSearch?boolean
Enable web search for URL discovery
Default
falseagent?
Agent configuration
scrapeOptions?
Scrape options for each URL
webhook?
Webhook configuration
ignoreSitemap?boolean
Ignore sitemap during URL discovery
Default
falseincludeSubdomains?boolean
Include subdomains in extraction
Default
trueshowSources?boolean
Include source citations in response
Default
falseignoreInvalidURLs?boolean
Ignore invalid URLs and process remaining valid ones
Default
trueResponse Body
application/json
curl -X POST "https://example.com/extract" \ -H "Content-Type: application/json" \ -d '{ "prompt": "Extract all product names, prices, and descriptions from these pages" }'{ "id": "extract_uuid", "status": "PENDING", "url": "/extract/extract_uuid"}Empty