Skip to content

Latest commit

 

History

History
30 lines (16 loc) · 1.37 KB

SummaryCreationPayload.md

File metadata and controls

30 lines (16 loc) · 1.37 KB

SummaryCreationPayload

Properties

Name Type Description Notes
videoId string Create a summary of a video using the video ID.
origin SummaryCreationPayloadOriginEnum 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. If you do not set this parameter, the API will not generate a summary automatically. In this case, `sourceStatus` will return `missing`, and you have to manually add a summary using the `PATCH /summaries/{summaryId}/source` endpoint operation. [optional]
attributes Array<SummaryCreationPayloadAttributesEnum> 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`. [optional]

Enum: SummaryCreationPayloadOriginEnum

Name Value
Auto 'auto'

Enum: Array<SummaryCreationPayloadAttributesEnum>

Name Value
Abstract 'abstract'
Takeaways 'takeaways'