Actions5
Extract from Image
AI-generatedSummary
Extract structured data from images or photos by providing either binary file data or a file URL, optionally specifying the fields to extract via a simple field builder or an advanced JSON schema.
Inputs
- Input Method (required) — Choose whether to provide the image file via binary data from a previous node or download it from a URL.
- Input Binary Field (required) — When using binary input, specify the name of the binary field containing the image data, typically 'data'.
- File URL (required) — When using URL input, provide the URL of the image file to download and extract data from.
- Define Output Fields — Indicate whether to specify which data fields to extract from the image.
- Schema Mode — Select between a simple user-friendly field builder or providing an advanced JSON schema to define the output data structure, shown only if defining output fields.
- Output Fields — Use the simple field builder to add multiple fields by name, type, and optional description to guide extraction; shown only if defining fields and using simple schema mode.
- JSON Schema — Provide a complete JSON schema describing the structure and type of data to extract; shown only if defining fields and using advanced schema mode.
- Options.Include Metadata — Choose to include metadata such as filename, file type, and extraction status in the output.
- Options.Simplify — Choose whether to return a simplified version of the API response or the raw detailed data.
Output shape
a list of items each containing the extracted structured data from the image, optionally including metadata or raw response if requested
Outputs one item per input with extracted data under 'extracted_data' or directly as fields if simplified output is enabled. Metadata fields like filename, file type, and status appear if requested. If extraction fails and 'Continue On Fail' is enabled, errors are returned per item.
Examples
Example 1: Extract invoice number and date from an invoice photo provided as binary data.
Select 'Extract from Image' operation, input method 'Binary Data', set binary field to 'data', enable 'Define Output Fields', use simple schema mode to define fields 'invoice_number' (string) and 'date' (string).
Example 2: Extract structured data from image file at a URL using an advanced JSON schema.
Select 'Extract from Image' operation, input method 'URL', provide file URL, enable 'Define Output Fields', choose 'Advanced (JSON Schema)' mode, and provide a JSON schema defining expected fields and their types.