Parseflow · Schema

Parseflow Search Response

Response from GET /v2/search.

Document ParsingPDFOCRText ExtractionDocument AISearchBYOKAsync JobsWebhooksREST

Properties

Name Type Description
query string
limit integer
total integer
results array
View JSON Schema on GitHub

JSON Schema

parseflow-search-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://docs.parseflow.tech/schemas/search-response.json",
  "title": "Parseflow Search Response",
  "description": "Response from GET /v2/search.",
  "type": "object",
  "required": ["query", "results"],
  "properties": {
    "query": { "type": "string" },
    "limit": { "type": "integer", "default": 10 },
    "total": { "type": "integer", "minimum": 0 },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["document_id", "score"],
        "properties": {
          "document_id": { "type": "string" },
          "score": { "type": "number" },
          "snippet": { "type": "string" },
          "filename": { "type": ["string", "null"] },
          "chunk_index": { "type": ["integer", "null"] }
        }
      }
    }
  }
}