Zamzar · Schema

Format

Represents the source format and an array of valid target formats.

File ConversionDocumentsVideoAudioImagesCADREST API

Properties

Name Type Description
name string The name of the format, synonymous with source format
targets array The conversions that Zamzar supports for this format, synonymous with target formats
View JSON Schema on GitHub

JSON Schema

format.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zamzar/main/json-schema/format.json",
  "title": "Format",
  "type": "object",
  "description": "Represents the source format and an array of valid target formats.",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the format, synonymous with source format"
    },
    "targets": {
      "type": "array",
      "description": "The conversions that Zamzar supports for this format, synonymous with target formats",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the target format"
          },
          "credit_cost": {
            "type": "integer",
            "format": "int32",
            "description": "The number of base credits that are charged when scheduling a job for this conversion"
          }
        }
      }
    }
  },
  "example": {
    "name": "doc",
    "targets": [
      {"name": "docx", "credit_cost": 1},
      {"name": "pdf", "credit_cost": 1}
    ]
  }
}