Collection Documents

Download frame-accurate scene media for this document.

Changed on

Export this scene's media cut frame-accurately to its time range.

The document's video_segment_url serves the extraction-time clip, which is stream-copied and therefore keyframe-bounded — it can overshoot [start_time, end_time] by up to a GOP (~1s). This endpoint re-cuts from the ORIGINAL source with re-encode so the exported media matches the declared range within one source frame, caches the result beside the extraction clip, and returns a presigned download URL. The first call for a given range pays the re-encode (seconds, bounded); repeat calls serve the cache.

get/v1/collections/{collection_identifier}/documents/{document_id}/download

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/collections/{collection_identifier}/documents/{document_id}/download
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

collection_identifierstring required

The ID or name of the collection.

document_idstring required

The ID of the scene document.

Response

Successful Response

download_urlstring required

Presigned URL for the frame-accurate media cut.

cachedboolean required

Whether the cut was served from cache.

start_timenumber required

Scene start time in seconds.

end_timenumber required

Scene end time in seconds.

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 27f74c951c4dRevision changes
    • info

      endpoint added