Letta · Schema

FileMetadata

Representation of a single FileMetadata

AIAgentsStateful AgentsMemoryMemGPTContinual LearningMCPMulti-AgentRAGOpen Source

Properties

Name	Type	Description
source_id	string	Deprecated: Use `folder_id` field instead. The unique identifier of the source associated with the document.
file_name	object	The name of the file.
original_file_name	object	The original name of the file as uploaded.
file_path	object	The path to the file.
file_type	object	The type of the file (MIME type).
file_size	object	The size of the file in bytes.
file_creation_date	object	The creation date of the file.
file_last_modified_date	object	The last modified date of the file.
processing_status	object	The current processing status of the file (e.g. pending, parsing, embedding, completed, error).
error_message	object	Optional error message if the file failed processing.
total_chunks	object	Total number of chunks for the file.
chunks_embedded	object	Number of chunks that have been embedded.
content	object	Optional full-text content of the file; only populated on demand due to its size.
id	string	The human-friendly ID of the File
created_at	object	The creation date of the file.
updated_at	object	The update date of the file.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FileMetadata",
  "title": "FileMetadata",
  "properties": {
    "source_id": {
      "type": "string",
      "title": "Source Id",
      "description": "Deprecated: Use `folder_id` field instead. The unique identifier of the source associated with the document.",
      "deprecated": true
    },
    "file_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "File Name",
      "description": "The name of the file."
    },
    "original_file_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Original File Name",
      "description": "The original name of the file as uploaded."
    },
    "file_path": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "File Path",
      "description": "The path to the file."
    },
    "file_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "File Type",
      "description": "The type of the file (MIME type)."
    },
    "file_size": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "File Size",
      "description": "The size of the file in bytes."
    },
    "file_creation_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "File Creation Date",
      "description": "The creation date of the file."
    },
    "file_last_modified_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "File Last Modified Date",
      "description": "The last modified date of the file."
    },
    "processing_status": {
      "$ref": "#/components/schemas/FileProcessingStatus",
      "description": "The current processing status of the file (e.g. pending, parsing, embedding, completed, error).",
      "default": "pending"
    },
    "error_message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Error Message",
      "description": "Optional error message if the file failed processing."
    },
    "total_chunks": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Total Chunks",
      "description": "Total number of chunks for the file."
    },
    "chunks_embedded": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Chunks Embedded",
      "description": "Number of chunks that have been embedded."
    },
    "content": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Content",
      "description": "Optional full-text content of the file; only populated on demand due to its size."
    },
    "id": {
      "type": "string",
      "pattern": "^file-[a-fA-F0-9]{8}",
      "title": "Id",
      "description": "The human-friendly ID of the File",
      "examples": [
        "file-123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "created_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created At",
      "description": "The creation date of the file."
    },
    "updated_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At",
      "description": "The update date of the file."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "source_id"
  ],
  "description": "Representation of a single FileMetadata"
}