Sign in
extract

Suggest an extraction schema

Suggest an extraction JSON Schema from a tenant-owned succeeded parse result. Optional hint is capped at 500 characters. Definitive failures return schema_suggestion_failed.

post/suggest-schema

Request

  • Base URL: https://api.openparser.dev
  • URL: https://api.openparser.dev/suggest-schema
  • Auth: HTTP bearer

Request body

parse_job_idstring required

Prefixed id (opj_…) of a succeeded parse job in the same tenant.

hintstring

Optional free-text guidance for the suggestion model (max 500 characters).

Response

Suggested schema

namestring required

Short document-type label proposed by the model.

schemaobject required

Canonical JSON Schema object ready for extract and manual editing.

Changes

No recorded changes to this operation across all 4 revisions of this API.