Summaries

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/api-video/json-schema/api-video-summaries-list-response-schema.json",
  "title": "Summaries",
  "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/summaries-list-response",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "An array of summary objects.",
      "items": {
        "$ref": "#/$defs/summary"
      }
    },
    "pagination": {
      "$ref": "#/$defs/pagination"
    }
  },
  "required": [
    "data",
    "pagination"
  ],
  "$defs": {
    "pagination": {
      "title": "Pagination",
      "required": [
        "links"
      ],
      "type": "object",
      "properties": {
        "itemsTotal": {
          "type": "integer",
          "description": "Total number of items that exist.",
          "readOnly": true
        },
        "pagesTotal": {
          "type": "integer",
          "description": "Number of items listed in the current page.",
          "readOnly": true
        },
        "pageSize": {
          "type": "integer",
          "description": "Maximum number of item per page.",
          "readOnly": true
        },
        "currentPage": {
          "type": "integer",
          "description": "The current page index.",
          "readOnly": true
        },
        "currentPageItems": {
          "type": "integer",
          "description": "The number of items on the current page.",
          "readOnly": true
        },
        "links": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/pagination-link"
          }
        }
      }
    },
    "pagination-link": {
      "title": "PaginationLink",
      "type": "object",
      "properties": {
        "rel": {
          "type": "string"
        },
        "uri": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "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"
          ]
        }
      }
    }
  }
}