ClipJobRefEnvelope

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/everpop-app/json-schema/everpop-app-clip-job-ref-envelope-schema.json",
  "title": "ClipJobRefEnvelope",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/everpop-app-clip-api-openapi.yml#/components/schemas/ClipJobRefEnvelope",
  "type": "object",
  "properties": {
    "ok": {
      "const": true
    },
    "data": {
      "$ref": "#/$defs/ClipJobRef"
    }
  },
  "required": [
    "ok",
    "data"
  ],
  "$defs": {
    "ClipJobRef": {
      "type": "object",
      "properties": {
        "jobId": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "PENDING",
            "PROCESSING",
            "COMPLETED",
            "FAILED",
            "CANCELED"
          ]
        },
        "poll": {
          "type": "string",
          "description": "Relative URL to poll, e.g. /api/v1/jobs/{id}"
        },
        "clipCountApplied": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The clip count the job runs with after the plan's per-video cap (1 for a Summary or Punch, which deliver one video)."
        },
        "aspectRatio": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "9:16",
            "1:1",
            "16:9",
            "4:5",
            null
          ],
          "description": "The aspect ratio the job renders at: the request's aspectRatio, or the account's saved setting when it was omitted."
        },
        "captionsEnabled": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Whether the job burns captions in: the request's captionsEnabled, or the account's saved setting when it was omitted."
        }
      },
      "required": [
        "jobId",
        "status",
        "poll",
        "clipCountApplied",
        "aspectRatio",
        "captionsEnabled"
      ]
    }
  }
}