Sign in
pipelines

Create a saved extraction pipeline

Changed on

Persist a tenant-scoped extraction configuration (OCR model, LLM model, schema, repair/grounding/reasoning). Validated with the same admission gates as extract. Playground tokens and ocr:full keys are both accepted.

post/pipelines

Request

  • Base URL: https://api.openparser.dev
  • URL: https://api.openparser.dev/pipelines
  • Auth: HTTP bearer

Request body

namestring required
slugstring
ocr_modelstring required
ocr_optionsobject
llm_modelstring required
schemaobject required

JSON Schema object describing fields to extract. Root must be an object schema with explicit properties and at least one named property. Admission applies the same strict structured-output normalization as extract.

repair_attemptsinteger
grounding'none' | 'field'

Response

Successful response

idstring required

Prefixed public id for a saved extraction pipeline (oppl_…).

namestring required
slugstring nullable required
versioninteger required
ocr_modelstring required
ocr_optionsobject required
llm_modelstring required

OpenRouter model slug from the compatible OCR extraction catalog (GET /models/llm). Unknown or deprecated values return 422 unsupported_llm_model. Any currently compatible model may be used for extract and field grounding.

schemaobject required

Persisted extraction schema with at least one root property. Normalized for strict structured outputs at save time.

repair_attemptsinteger required
grounding'none' | 'field' required

Extraction grounding mode. none preserves ordinary extraction. field requests verified per-leaf source citations (citation v1 emits element-level citations only).

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "llm_model": "openai/gpt-5.6-terra"
}

Changes

  • 4561194517a8Revision changes
    • breaking

      added 'propertyNames' constraint to the request property

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • info

      added 'propertyNames' constraint to the response property for the status