mindee

List the document-extraction models available to your Mindee account (id, name, type). Use a model's `id` as the model_id for mindee_extract_document. V2 API: GET /v2/search/models.

{
  "type": "object",
  "properties": {
    "name": {
      "description": "Optional case-insensitive name filter, e.g. 'invoice'.",
      "type": "string"
    },
    "model_type": {
      "description": "Optional model type filter.",
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Check the processing status of an enqueued document by job id. Status is Waiting | Processing | Processed | Failed. When Processed, the response carries a result_url; pass that inference id to mindee_get_inference. V2 API: GET /v2/jobs/{job_id}.

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Job id returned by mindee_extract_document (when it times out) or an enqueue call."
    }
  },
  "required": [
    "job_id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Fetch the structured result of a completed inference by id, returned as a compact map of extracted fields (plus raw_text if it was requested). V2 API: GET /v2/inferences/{inference_id}.

{
  "type": "object",
  "properties": {
    "inference_id": {
      "type": "string",
      "description": "Inference id (from a Processed job's result_url, or from mindee_extract_document)."
    },
    "raw": {
      "description": "Return the full unshaped API response instead of the compact fields map. Default false.",
      "type": "boolean"
    }
  },
  "required": [
    "inference_id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Submit a document (PDF or image) to a Mindee extraction model and return the structured fields. Provide EITHER document_url (a public URL) OR file_base64 (+ filename). This enqueues an inference and polls until it completes (up to ~30s); if it is still processing it returns a job_id you can poll with mindee_get_job then read with mindee_get_inference. NOTE: consumes Mindee API credits (paid, billed per page). V2 API: POST /v2/inferences/enqueue.

{
  "type": "object",
  "properties": {
    "model_id": {
      "type": "string",
      "description": "Extraction model id (from mindee_list_models)."
    },
    "document_url": {
      "description": "Public URL of the document to process. Use this OR file_base64.",
      "type": "string",
      "format": "uri"
    },
    "file_base64": {
      "description": "Base64-encoded document bytes. Use this OR document_url; set `filename` too.",
      "type": "string"
    },
    "filename": {
      "description": "Filename for file_base64 uploads, e.g. 'invoice.pdf'.",
      "type": "string"
    },
    "alias": {
      "description": "Your own reference tag echoed back in the job/result.",
      "type": "string"
    },
    "webhook_ids": {
      "description": "Webhook ids to notify on completion (async flows).",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "rag": {
      "description": "Enable Retrieval-Augmented Generation for the model, if configured.",
      "type": "boolean"
    },
    "raw_text": {
      "description": "Also return the full OCR raw text of the document.",
      "type": "boolean"
    },
    "polygon": {
      "description": "Return bounding-box polygons for fields.",
      "type": "boolean"
    },
    "confidence": {
      "description": "Return per-field confidence levels (Certain/High/Medium/Low).",
      "type": "boolean"
    }
  },
  "required": [
    "model_id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}