Skip to main content

Request a custom summary

POST 
/api/v1/videos/:video_id/custom-summaries

Ask for a summary of an indexed video written to your instructions. The request is queued; poll GET /v1/videos/{video_id}/custom-summaries/{custom_summary_id} for the result.

The standard result of the video is never changed. cast lists the only person names the summary may use; with no cast, the summary is instructed to write no person names. Sections in which a name outside cast is detected are returned as null; this check is best-effort (it can miss names and can also blank a section that merely contains a place or brand name), so review the result where names matter. language (default en) takes precedence over any language in instructions. Length is fixed by the service.

Instructions outside the supported scope end as status: rejected with a message (read it with the GET). When the same instructions were already judged out of scope, this response already has status: rejected and nothing is generated. A malformed body returns 422; a video that has no standard summary yet returns 422 with code: custom_summary_no_base_summary. A key or session that belongs to no organization returns 422 with code: custom_summary_no_org. 503 means the request was not queued; each retry creates a new request.

Each request counts as one summary against your organization's summary quota (summaries in GET /v1/usage), separate from the video quota, including a request that ends as rejected. A request that ends as failed, or is still queued when its video is deleted, is returned to the quota. When the summary quota is exhausted the response is 422 with code: quota_exceeded_summaries and nothing is created.

Request​

Responses​

Successful Response