Sign in

v48

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-0297180624.8 KB
UI Action

Extract data

Extract data from the UI interface using a JSON schema.

post/boxes/{boxId}/actions/extract

Path parameters

boxIdstring required
Example:c9bdc193-b54b-4ddb-a035-5ac0c598d32d

Box ID

Request body

instructionstring required

The instruction of the action to extract data from the UI interface

schemaobject

JSON Schema defining the structure of data to extract. Supports object, array, string, number, boolean types with validation rules.

Common use cases:

  • Extract text content: { "type": "string" }
  • Extract structured data: { "type": "object", "properties": {...} }
  • Extract lists: { "type": "array", "items": {...} }
  • Extract with validation: Add constraints like "required", "enum", "pattern", etc.

Example request

{
  "instruction": "extract the product information including title, price, and availability status"
}

Response

dataobject required

The extracted data structure that conforms to the provided JSON schema. The actual structure and content depend on the schema defined in the extract action request.

screenshotstring byte required

Base64-encoded screenshot of the UI interface at the time of extraction

Example response

{
  "screenshot": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
}