PAparsewise
Projects

Get output schema

Read the target JSON output schema, automatic mapping mode, stored mapping, lifecycle state, and live diagnostics. Poll this endpoint until status reaches success after enabling automatic mapping.

get/projects/{project_id}/schema/

Request

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

Path parameters

project_idstring uuid required

Response

schemaunknown required
auto_mapboolean required

Whether automatic agent and mapping generation is active for the current mapping state.

mappingunknown required
status'pending' | 'success' | 'failed' required
  • pending - pending
  • success - success
  • failed - failed
source'llm' | 'manual' required
  • llm - llm
  • manual - manual
errorstring nullable required

Failure detail when status is failed, otherwise null.

generated_atstring date-time nullable required

When the mapping was last saved or generated.

schema_in_syncboolean required

True when the mapping was saved against the current output schema. False after the schema changes, meaning the mapping should be re-saved or regenerated.

Changes

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