Mindee · Schema

Mindee Job

An asynchronous Mindee processing job returned by GET /v2/jobs/{job_id}.

Document ParsingOCRIDPAIMachine LearningInvoicesReceiptsIDsComputer Vision

Properties

Name Type Description
job object
View JSON Schema on GitHub

JSON Schema

mindee-job-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindee/main/json-schema/mindee-job-schema.json",
  "title": "Mindee Job",
  "description": "An asynchronous Mindee processing job returned by GET /v2/jobs/{job_id}.",
  "type": "object",
  "required": ["job"],
  "properties": {
    "job": {
      "type": "object",
      "required": ["id", "status"],
      "properties": {
        "id": { "type": "string", "description": "Unique identifier of the job." },
        "model": {
          "type": "object",
          "properties": {
            "id": { "type": "string" },
            "name": { "type": "string" }
          }
        },
        "status": {
          "type": "string",
          "enum": ["Waiting", "Processing", "Failed", "Success"]
        },
        "created_at": { "type": "string", "format": "date-time" },
        "polling_url": { "type": "string", "format": "uri" },
        "result_url": { "type": ["string", "null"], "format": "uri" },
        "webhook_url": { "type": ["string", "null"], "format": "uri" },
        "error": {
          "type": ["object", "null"],
          "properties": {
            "code": { "type": "string" },
            "message": { "type": "string" }
          }
        }
      }
    }
  }
}