FileWithID

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/sonetel/main/json-schema/sonetel-file-with-id-schema.json",
  "title": "FileWithID",
  "description": "File meta data",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sonetel-ai-file-manager-openapi.yml#/components/schemas/FileWithID",
  "type": "object",
  "properties": {
    "file_id": {
      "type": "string",
      "description": "The unique ID of the file",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "The file name with extension"
    },
    "type": {
      "type": "string",
      "enum": [
        "audio",
        "video",
        "image",
        "text",
        "other"
      ],
      "description": "The type of file - audio, video, image, text or other. The file type is automatically detected during upload by the file manager",
      "readOnly": true
    },
    "size": {
      "type": "integer",
      "description": "The size of the file in bytes",
      "format": "int64",
      "readOnly": true
    },
    "storage": {
      "type": "string",
      "enum": [
        "file-mgr",
        "sonetel-call-recording",
        "sonetel-voicemail",
        "google-drive",
        "one-drive",
        "dropbox"
      ],
      "description": "The storage type of the file. A file may be stored in storage managed by file manager, or storage managed by other services such as Sonetel's call recording, or external cloud storage services such as Google or Microsoft one-drive or dropbox.",
      "readOnly": true
    },
    "extension": {
      "type": "string",
      "description": "The file name extension such as `jpg`, `mp4` etc.",
      "readOnly": true
    },
    "mime_type": {
      "type": "string",
      "description": "The [standard IANA mime type](https://www.iana.org/assignments/media-types/media-types.xhtml) of the file",
      "readOnly": true
    },
    "public_url": {
      "type": "string",
      "description": "The public URL of the file for files that have visibility set to `public`",
      "format": "uri-reference",
      "readOnly": true
    },
    "description": {
      "type": "string",
      "description": "Textual description of the file"
    },
    "create_date": {
      "type": "string",
      "description": "The create date/time of the file",
      "format": "date-time",
      "readOnly": true
    },
    "modify_date": {
      "type": "string",
      "description": "The last modified date of the file meta data. File content cannot be modified",
      "format": "date-time",
      "readOnly": true
    },
    "visibility": {
      "type": "string"
    },
    "image_meta_data": {
      "$ref": "#/$defs/ImageMetaData",
      "description": "Image specific meta data for image files"
    },
    "video_meta_data": {
      "$ref": "#/$defs/VideoMetaData",
      "description": "Video specific meta data for video files"
    },
    "audio_meta_data": {
      "$ref": "#/$defs/AudioMetaData",
      "description": "Audio specific meta data for audio files"
    },
    "account_id": {
      "type": "string",
      "description": "The Sonetel account Id that owns the file",
      "readOnly": true
    },
    "user_id": {
      "type": "string",
      "description": "The Sonetel user Id that owns the file",
      "readOnly": true
    },
    "business_id": {
      "type": "string",
      "description": "The Sonetel business Id to which the file is associated"
    },
    "in_use_with": {
      "$ref": "#/$defs/InUseWith",
      "description": "List of services the file is in use with and expiry timestamp for each"
    },
    "temp_url": {
      "type": "string",
      "description": "A secure temporary URL that expires in 180 seconds.",
      "format": "uri"
    },
    "created_by": {
      "type": "string",
      "enum": [
        "ai-meeting-mins",
        "user",
        "ai-photo-finder",
        "sonetel-call-recording"
      ],
      "description": "The service that created this file. In case a user has created this, this value is set to `user` and the `user_id` field carries the `user_id `of the user that created this "
    },
    "store_obj_id": {
      "type": "string",
      "description": "Reference Id of the file in the object storage"
    }
  },
  "$defs": {
    "AudioMetaData": {
      "type": "object",
      "title": "AudioMetaData",
      "description": "Meta data for audio files",
      "properties": {
        "duration": {
          "type": "integer",
          "description": "The audio length in seconds",
          "format": "int32"
        },
        "codec": {
          "type": "string",
          "description": "The [audio codec](https://www.iana.org/assignments/media-types/media-types.xhtml#audio) used"
        },
        "bitrate": {
          "type": "integer",
          "description": "The audio bitrate in kbps"
        },
        "sampling_rate": {
          "enum": [
            44.1,
            48,
            22.05,
            32,
            88.2,
            96
          ],
          "description": "Sampling rate of the audio"
        }
      }
    },
    "ImageMetaData": {
      "type": "object",
      "title": "ImageMetaData",
      "description": "Meta data for image files",
      "properties": {
        "resolution": {
          "type": "string",
          "description": "The image resolution",
          "format": "regex",
          "pattern": "^\\d{3,4}x\\d{3,4}$"
        },
        "color_space": {
          "type": "string",
          "description": "The color space of the image such as `RGB` or `CMYK`"
        },
        "image_format": {
          "type": "string",
          "enum": [
            "jpg",
            "png",
            "gif",
            "bmp",
            "tiff",
            "svg"
          ],
          "description": "The image format such as `jpg`, `png`"
        },
        "bit_depth": {
          "type": "integer",
          "description": "The bit depth of the image",
          "format": "int32"
        }
      }
    },
    "InUseWith": {
      "type": "array",
      "title": "InUseWith",
      "description": "Information about services file is in use with",
      "items": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "enum": [
              "ai-meeting-minutes",
              "ai-call-summary",
              "ai-vmail-summary"
            ],
            "description": "The service the file is in use with"
          },
          "auto_expire": {
            "type": "string",
            "description": "Automatic expiry timestamp when the file is no longer required by the service\r\nAn empty value implies that the file is never automatically deleted",
            "format": "date-time"
          }
        }
      }
    },
    "VideoMetaData": {
      "type": "object",
      "title": "VideoMetaData",
      "description": "Meta data for video files",
      "properties": {
        "duration": {
          "type": "integer",
          "description": "The length in seconds of the video file"
        },
        "codec": {
          "type": "string",
          "description": "The [video codec](https://www.iana.org/assignments/media-types/media-types.xhtml#video) used"
        },
        "resolution": {
          "type": "string",
          "enum": [
            "480p",
            "576p",
            "720p",
            "1080p",
            "1440p",
            "4K",
            "8K"
          ],
          "description": "The video resolution"
        },
        "bitrate": {
          "type": "integer",
          "description": "The video bitrate in kbps",
          "format": "int32"
        },
        "frame_rate": {
          "type": "integer",
          "description": "The frame rate in frames per second (fps)",
          "format": "int32"
        },
        "audio_codec": {
          "type": "string",
          "description": "The [audio code](https://www.iana.org/assignments/media-types/media-types.xhtml#audio) used"
        },
        "audio_channels": {
          "type": "integer",
          "description": "The number of audio channels in the video",
          "format": "int32"
        },
        "language": {
          "type": "string",
          "description": "The language of the audio. [2 char ISO](https://en.wikipedia.org/wiki/ISO_639-1) or [IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag)"
        }
      }
    }
  }
}