PAparsewise
Projects

Set output schema

Set the target JSON output schema and choose automatic or manual mapping. Automatic mapping clears any stored mapping and regenerates agents and the mapping in the background. Manual mapping can be provided in the same request, explicitly cleared with null, or omitted only for a new or changed schema that has no usable mapping.

put/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

Request body

schemaunknown required
auto_mapboolean required

When true, clear any stored mapping and generate agents and a new mapping in the background. When false, manage the mapping manually in this request.

mappingunknown

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.