summary

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/api-video/json-schema/api-video-summary-schema.json",
  "title": "summary",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/api-video-summaries-api-openapi.yml#/components/schemas/summary",
  "type": "object",
  "properties": {
    "summaryId": {
      "type": "string",
      "description": "The unique identifier of the summary object."
    },
    "createdAt": {
      "description": "Returns the date and time when the summary was created in ATOM date-time format.",
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "description": "Returns the date and time when the summary was last updated in ATOM date-time format.",
      "type": "string",
      "format": "date-time"
    },
    "videoId": {
      "type": "string",
      "description": "The unique identifier of the video object."
    },
    "origin": {
      "type": "string",
      "enum": [
        "api",
        "auto"
      ],
      "description": "Returns the origin of how the summary was created.\n\n- `api` means that no summary was generated automatically. You can add summary manually using the `PATCH /summaries/{summaryId}/source` endpoint operation. Until this happens, `sourceStatus` returns `missing`.\n- `auto` means that the API generated the summary automatically."
    },
    "sourceStatus": {
      "type": "string",
      "description": "Returns the current status of summary generation.\n\n`missing`: the input for a summary is not present.\n`waiting` : the input video is being processed and a summary will be generated.\n`failed`: a technical issue prevented summary generation.\n`completed`: the summary is generated.\n`unprocessable`: the API rules the source video to be unsuitable for summary generation. An example for this is an input video that has no audio.",
      "enum": [
        "missing",
        "waiting",
        "failed",
        "completed",
        "unprocessable"
      ]
    }
  }
}