Document

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/h2o-ai/main/json-schema/h2o-ai-document-schema.json",
  "title": "Document",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/h2o-ai-collections-api-openapi.yml#/components/schemas/Document",
  "required": [
    "id",
    "name",
    "username",
    "type",
    "size",
    "page_count",
    "created_at",
    "updated_at",
    "status"
  ],
  "type": "object",
  "properties": {
    "id": {
      "description": "A unique identifier of the document",
      "type": "string"
    },
    "name": {
      "description": "Name of the document",
      "type": "string"
    },
    "username": {
      "description": "A username owning the document",
      "type": "string"
    },
    "type": {
      "description": "Type of the document",
      "type": "string"
    },
    "size": {
      "description": "Size of the document in bytes",
      "type": "integer"
    },
    "page_count": {
      "description": "A number of pages contained in the document",
      "type": "integer"
    },
    "status": {
      "description": "Status of the document",
      "type": "string",
      "enum": [
        "unknown",
        "scheduled",
        "queued",
        "running",
        "completed",
        "failed",
        "canceled",
        "agent_only"
      ]
    },
    "usage_stats": {
      "description": "Usage stats",
      "type": "string"
    },
    "connector": {
      "type": "string"
    },
    "original_type": {
      "type": "string"
    },
    "original_mtime": {
      "type": "string",
      "format": "datetime"
    },
    "created_at": {
      "description": "Time when document was created",
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "description": "Last time when document was modified",
      "type": "string",
      "format": "date-time"
    },
    "uri": {
      "type": "string"
    },
    "summary": {
      "type": "string"
    },
    "summary_parameters": {
      "type": "string"
    },
    "metadata_dict": {
      "$ref": "#/$defs/Metadata"
    },
    "is_encrypted": {
      "description": "Whether the document files are encrypted at rest",
      "type": "boolean",
      "default": false
    }
  },
  "$defs": {
    "Metadata": {
      "type": "object",
      "additionalProperties": true
    }
  }
}