ConversionRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/file-convert-online/json-schema/file-convert-online-conversion-request-schema.json",
  "title": "ConversionRequest",
  "description": "Body for POST /api/conversion/v1/conversion. The four ID fields are required. Obtain the ID values from the formats catalogue (GET /api/conversion/v1/file_formats and GET /api/conversion/v1/file_formats/types).\n**`additional_arguments` MUST be sent as an explicit empty object `{}` when not used.** Do not omit the field and do not send `null` — the underlying JSONB column rejects absent/null values at the database layer. This is a known service-side constraint, not a schema requirement; the service does not return a validation error on omission in all cases, but passing `{}` is the only safe behaviour for conformant clients.\n",
  "x-generated": "2026-11-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/file-convert-online-mcp-openapi.json#/components/schemas/ConversionRequest",
  "type": "object",
  "properties": {
    "file_uid": {
      "type": "string",
      "minLength": 36,
      "maxLength": 36,
      "description": "UID of the source file returned by POST /api/file/v1/file."
    },
    "format_type_id": {
      "type": "integer",
      "minimum": 1,
      "description": "Format-type category ID (from GET /api/conversion/v1/file_formats/types)."
    },
    "source_format_id": {
      "type": "integer",
      "minimum": 1,
      "description": "Source file format ID (from GET /api/conversion/v1/file_formats)."
    },
    "target_format_id": {
      "type": "integer",
      "minimum": 1,
      "description": "Target file format ID (from GET /api/conversion/v1/file_formats)."
    },
    "additional_arguments": {
      "type": "object",
      "additionalProperties": true,
      "description": "Free-form converter arguments. Send `{}` when unused — do not omit or send null.\n"
    },
    "effects": {
      "type": "array",
      "description": "Optional post-processing effects from the effects catalogue.",
      "items": {
        "$ref": "#/$defs/ConversionEffectRequest"
      }
    }
  },
  "required": [
    "file_uid",
    "format_type_id",
    "source_format_id",
    "target_format_id"
  ],
  "$defs": {
    "ConversionEffectRequest": {
      "type": "object",
      "properties": {
        "effect_id": {
          "type": "integer",
          "minimum": 1,
          "description": "Effect ID from GET /api/conversion/v1/effects."
        },
        "params": {
          "type": "object",
          "additionalProperties": true,
          "description": "Parameter values matching the effect's schema."
        }
      },
      "required": [
        "effect_id"
      ]
    }
  }
}