summary-creation-payload

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/api-video/json-schema/api-video-summary-creation-payload-schema.json",
  "title": "summary-creation-payload",
  "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-creation-payload",
  "required": [
    "videoId"
  ],
  "type": "object",
  "properties": {
    "videoId": {
      "type": "string",
      "description": "Create a summary of a video using the video ID."
    },
    "origin": {
      "type": "string",
      "enum": [
        "auto"
      ],
      "description": "Use this parameter to define how the API generates the summary. The only allowed value is `auto`, which means that the API generates a summary automatically.\n\nIf you do not set this parameter, **the API will not generate a summary automatically**.\n\nIn this case, `sourceStatus` will return `missing`, and you have to manually add a summary using the `PATCH /summaries/{summaryId}/source` endpoint operation."
    },
    "attributes": {
      "description": "Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. The possible values are `abstract` and `takeaways`.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "abstract",
          "takeaways"
        ]
      }
    }
  }
}