Parseflow · Schema

Parseflow Batch Request

JSON body for POST /v2/batch. Mirrors the BatchRequest component in the upstream OpenAPI.

Document ParsingPDFOCRText ExtractionDocument AISearchBYOKAsync JobsWebhooksREST

Properties

Name Type Description
documents array
preset stringnull
schema_json objectnull
enforce_schema boolean
chunk_size integer
overlap integer
mode string
View JSON Schema on GitHub

JSON Schema

parseflow-batch-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://docs.parseflow.tech/schemas/batch-request.json",
  "title": "Parseflow Batch Request",
  "description": "JSON body for POST /v2/batch. Mirrors the BatchRequest component in the upstream OpenAPI.",
  "type": "object",
  "required": ["documents"],
  "properties": {
    "documents": {
      "type": "array",
      "minItems": 1,
      "items": { "$ref": "#/$defs/BatchDocumentInput" }
    },
    "preset": { "type": ["string", "null"] },
    "schema_json": {
      "type": ["object", "null"],
      "additionalProperties": true
    },
    "enforce_schema": { "type": "boolean", "default": false },
    "chunk_size": { "type": "integer", "default": 2000 },
    "overlap": { "type": "integer", "default": 200 },
    "mode": {
      "type": "string",
      "default": "basic",
      "enum": ["basic", "deterministic", "byok_assisted"]
    }
  },
  "$defs": {
    "BatchDocumentInput": {
      "type": "object",
      "required": ["text"],
      "properties": {
        "text": { "type": "string" },
        "filename": { "type": ["string", "null"] },
        "document_id": { "type": ["string", "null"] },
        "chunk_size": { "type": ["integer", "null"] },
        "overlap": { "type": ["integer", "null"] },
        "mode": { "type": ["string", "null"] },
        "schema_json": {
          "type": ["object", "null"],
          "additionalProperties": true
        }
      }
    }
  }
}