Skip to main content
Extract structured data from the current page by providing a schema. The extraction uses the current page state, making it ideal for capturing data mid-workflow.

Usage

Request

dict
required
A JSON schema describing the structure of the data to extract. Include description fields to help guide the extraction.Example:
string
Optional prompt to guide the extraction. Use this to filter results, specify quantity, or handle ambiguous cases.Example: Extract only the products that are currently in stock and under $50

Response

Returns an object with the following attributes.
any
The extracted data conforming to the provided schema.
float
The number of credits used for this action. 1 credit corresponds to $0.01.
float
The duration in seconds taken to perform the extraction.

Examples

Extract a single object:
Extract a list of items:
Filtering with prompt: Use the prompt to filter, sort, or apply conditions that go beyond what the schema can express.
Extract and use data to guide next action: