Get results in schema format

Return extraction results shaped to the project’s target output schema. The response body is the JSON object conforming to the schema set via PUT /projects/{project_id}/schema/. Returns 400 if no schema is configured, 409 if the mapping is still being generated, and 422 if mapping generation failed.

On this page

• HTTP request
• URI Parameters
• Request Header
• Responses
• Security
• Python example

HTTP request

GET https://api.parsewise.ai/api/v1/projects/{project_id}/results/schema/

URI Parameters

Name	In	Required	Type	Description
enrich	query	No	boolean	When true, each scalar leaf gains sibling fields <field>_consistency (resolution status) and <field>_parsewise_url (deep link to the result in the UI).
project_id	path	Yes	string (uuid)

Request Header

Name	Required	Type	Description
X-API-Key	Yes	string	API key with the pw_live_ prefix. See Authentication.

Responses

Status	Type	Description
200	object<string, any>	—

Security

• ApiKeyAuth — apiKey — in X-API-Key header. API key with pw_live_ prefix.

Python example

import os
import requests

API_KEY = os.environ["PARSEWISE_API_KEY"]
BASE_URL = "https://api.parsewise.ai/api/v1"

project_id = "<uuid>"

params = {
    # "enrich": False,  # When true, each scalar leaf gains sibling fields `<field>_consistency` (resolution status) and `<field>_parsewise_url` (deep link to the result in the UI)
}

resp = requests.get(
    f"{BASE_URL}/projects/{project_id}/results/schema/",
    headers={"X-API-Key": API_KEY},
    params=params,
)
resp.raise_for_status()
print(resp.json() if resp.content else None)