Skip to content

Latest commit

 

History

History
150 lines (57 loc) · 4.33 KB

SummariesApi.md

File metadata and controls

150 lines (57 loc) · 4.33 KB
Raw

ApiVideo\Client\Api\SummariesApi

All URIs are relative to https://ws.api.video.

Method Description HTTP request
create() Generate video summary POST /summaries
update() Update summary details PATCH /summaries/{summaryId}/source
delete() Delete video summary DELETE /summaries/{summaryId}
list() List summaries GET /summaries
getSummarySource() Get summary details GET /summaries/{summaryId}/source

create() - Generate video summary

Generate an abstract and key takeaways for a video.

Arguments

Name Type Description Notes
summaryCreationPayload \ApiVideo\Client\Model\SummaryCreationPayload

Return type

\ApiVideo\Client\Model\Summary

update() - Update summary details

Update details for a summary.

Arguments

Name Type Description Notes
summaryId string The unique identifier of the summary source you want to update.
summaryUpdatePayload \ApiVideo\Client\Model\SummaryUpdatePayload

Return type

\ApiVideo\Client\Model\SummarySource

delete() - Delete video summary

Delete a summary tied to a video.

Arguments

Name Type Description Notes
summaryId string The unique identifier of the summary you want to delete.

Return type

void (empty response body)

list() - List summaries

List all summarries for your videos in a project.

Arguments

Note: queryParams argument is an associative array with the keys listed below.

Name Type Description Notes
videoId string Use this parameter to filter for a summary that belongs to a specific video. [optional]
origin string Use this parameter to filter for summaries based on the way they were created: automatically or manually via the API. [optional]
sourceStatus string Use this parameter to filter for summaries based on the current status of the summary source. These are the available statuses: `missing`: the input for a summary is not present. `waiting` : the input video is being processed and a summary will be generated. `failed`: a technical issue prevented summary generation. `completed`: the summary is generated. `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. [optional]
sortBy string Use this parameter to choose which field the API will use to sort the response data. The default is `value`. These are the available fields to sort by: - `createdAt`: Sorts the results based on date and timestamps when summaries were created. - `updatedAt`: Sorts the results based on date and timestamps when summaries were last updated. - `videoId`: Sorts the results based on video IDs. [optional]
sortOrder string Use this parameter to sort results. `asc` is ascending and sorts from A to Z. `desc` is descending and sorts from Z to A. [optional]
currentPage int Choose the number of search results to return per page. Minimum value: 1 [optional] [default to 1]
pageSize int Results per page. Allowed values 1-100, default is 25. [optional] [default to 25]

Return type

\ApiVideo\Client\Model\SummariesListResponse

getSummarySource() - Get summary details

Get all details for a summary.

Arguments

Name Type Description Notes
summaryId string The unique identifier of the summary source you want to retrieve.

Return type

\ApiVideo\Client\Model\SummarySource