ICiconik

Get asset's keyframe by ID

Required roles:

  • can_read_assets
get/v1/assets/{asset_id}/keyframes/{keyframe_id}/

Request

Path parameters

asset_idstring required
keyframe_idstring required

Query parameters

content_dispositionstring

Set to attachment if you do not want a download link

content_typestring

Content type to add to the pre-signed upload url

generate_signed_post_urlboolean

Set to true to get a new upload url for the keyframe

Headers

App-IDstring required
Auth-Tokenstring required

Response

Returns a keyframe associated with this asset

asset_idstring uuid nullable
collection_idstring uuid nullable
date_createdstring date-time
date_modifiedstring date-time
filenamestring
formatstring nullable
idstring uuid
is_custom_keyframeboolean
is_publicboolean
namestring
rotationinteger nullable
sizeinteger nullable
status'OPEN' | 'GROWING' | 'AWAITED' | 'CLOSED' | 'FAILED' | 'ARCHIVED' | 'MISSING' | 'REDISCOVERED' | 'DELETED'
storage_idstring uuid
storage_methodstring
type'KEYFRAME_MAP' | 'KEYFRAME' | 'POSTER' required
upload_credentialsobject
upload_headersobject
upload_methodstring
upload_urlstring
urlstring
version_idstring uuid nullable

Changes

No recorded changes to this operation across all 1 revision of this API.