Sign in
pipelines

Update a saved extraction pipeline

Changed on

Patch one or more fields, re-validate the effective merged config, and atomically increment version. In-flight and completed jobs keep their admit-time snapshots.

patch/pipelines/{id}

Request

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

Path parameters

idstring required

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

Tenant-scoped saved extraction pipeline identifier (oppl_…).

Request body

namestring
slugstring nullable
ocr_modelstring
ocr_optionsobject nullable
llm_modelstring
schemaobject

Replacement extraction schema. Root must be an object schema with explicit properties and at least one named property. Merged pipeline config is re-validated on every update.

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