{
  "opencollection": "1.0.0",
  "info": {
    "name": "Zuva DocAI API",
    "version": "2.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Files",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Upload a document file.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://us.app.zuva.ai/api/v2/files",
            "body": {
              "type": "binary",
              "data": ""
            }
          },
          "docs": "Upload the binary content of a document and receive a file_id."
        },
        {
          "info": {
            "name": "Delete multiple files.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://us.app.zuva.ai/api/v2/files"
          },
          "docs": "Delete multiple uploaded files by their file IDs."
        },
        {
          "info": {
            "name": "Delete a single file.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://us.app.zuva.ai/api/v2/files/{file_id}"
          },
          "docs": "Delete a single uploaded file."
        },
        {
          "info": {
            "name": "Update a file's expiration.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://us.app.zuva.ai/api/v2/files/{file_id}/expiration",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the retention period (expiration) of an uploaded file."
        }
      ]
    },
    {
      "info": {
        "name": "Field Extraction",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create field extraction requests.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://us.app.zuva.ai/api/v2/extraction",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submit files and field IDs to extract (up to 100 each)."
        },
        {
          "info": {
            "name": "Query multiple extraction requests.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://us.app.zuva.ai/api/v2/extractions"
          },
          "docs": "Query multiple extraction request statuses."
        },
        {
          "info": {
            "name": "Retrieve an extraction request status.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://us.app.zuva.ai/api/v2/extraction/{request_id}"
          },
          "docs": "Retrieve the status of an extraction request."
        },
        {
          "info": {
            "name": "Retrieve extraction text results.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://us.app.zuva.ai/api/v2/extraction/{request_id}/results/text"
          },
          "docs": "Fetch extracted field values with text spans and locations."
        }
      ]
    },
    {
      "info": {
        "name": "Classification",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a document classification request.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://us.app.zuva.ai/api/v2/mlc",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submit files to the multi-level classification (MLC) service."
        },
        {
          "info": {
            "name": "Query multiple classification requests.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://us.app.zuva.ai/api/v2/mlcs"
          },
          "docs": "Query multiple classification request statuses."
        },
        {
          "info": {
            "name": "Retrieve classification status and results.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://us.app.zuva.ai/api/v2/mlc/{request_id}"
          },
          "docs": "Retrieve document type, language, and amendment status."
        }
      ]
    },
    {
      "info": {
        "name": "OCR",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create an OCR request.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://us.app.zuva.ai/api/v2/ocr",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submit files for optical character recognition."
        },
        {
          "info": {
            "name": "Query multiple OCR requests.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://us.app.zuva.ai/api/v2/ocrs"
          },
          "docs": "Query multiple OCR request statuses."
        },
        {
          "info": {
            "name": "Retrieve an OCR request status.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://us.app.zuva.ai/api/v2/ocr/{request_id}"
          },
          "docs": "Retrieve the status of an OCR request."
        },
        {
          "info": {
            "name": "Retrieve OCR extracted text.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://us.app.zuva.ai/api/v2/ocr/{request_id}/text"
          },
          "docs": "Retrieve the extracted text for an OCR request."
        },
        {
          "info": {
            "name": "Download all page images as a zip.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://us.app.zuva.ai/api/v2/ocr/{request_id}/images"
          },
          "docs": "Download all pages as PNG images in a zip archive."
        },
        {
          "info": {
            "name": "Download a single page image.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://us.app.zuva.ai/api/v2/ocr/{request_id}/images/{page_number}"
          },
          "docs": "Download a specific page as a PNG image."
        },
        {
          "info": {
            "name": "Retrieve layout protobuf binary.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://us.app.zuva.ai/api/v2/ocr/{request_id}/layouts"
          },
          "docs": "Retrieve the layout protobuf binary for an OCR request."
        }
      ]
    },
    {
      "info": {
        "name": "Fields",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List available fields.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://us.app.zuva.ai/api/v2/fields"
          },
          "docs": "List all available extraction fields with metadata."
        },
        {
          "info": {
            "name": "Create a custom extraction field.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://us.app.zuva.ai/api/v2/fields",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a custom extraction field."
        },
        {
          "info": {
            "name": "Retrieve field metadata.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://us.app.zuva.ai/api/v2/fields/{field_id}/metadata"
          },
          "docs": "Retrieve metadata for a field."
        },
        {
          "info": {
            "name": "Update field metadata.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://us.app.zuva.ai/api/v2/fields/{field_id}/metadata",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a field's name and description."
        }
      ]
    }
  ],
  "bundled": true
}