Get output schema

Read back the target JSON output schema and the current mapping generation status. Use this to poll until mapping_status reaches success.

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}/schema/

URI Parameters

Name	In	Required	Type	Description
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>"

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