Extract

Extract structured data from documents

Upload one or more documents together with a target JSON schema. A project is created automatically. Set auto_map to true to run the full text extraction, agent generation, mapping, and extraction pipeline in the background, or false to configure agents and the mapping later through the project endpoints.

post/extract/

Request

  • Base URL
    https://api.parsewise.ai/api/v1
  • Auth
    API key in header X-API-Key

Request body multipart/form-data

filesstring[] required

One or more document files to process.

schemaunknown required
project_namestring

Optional name for the created project. Defaults to "API Extraction".

auto_mapboolean required

When true, agents and the schema mapping are generated automatically after text extraction. When false, only the schema is stored; create agents and save a mapping with PUT /projects/{project_id}/schema/ before fetching schema-shaped results.

Response

project_idstring uuid required
status_urlstring required
results_urlstring required

Changes

No recorded changes to this operation across all 1 revision of this API.