Create keyframe and associate to asset

Required roles:

can_write_keyframes

post/v1/assets/{asset_id}/method/{storage_method}/keyframes/

Request

Base URL
https://app.iconik.io/API/files
Auth
none declared. Required headers: App-ID, Auth-Token
TypeScript
https://skmtc.dev/iconik/apis/iconik-files/docs/v1/assets/:asset_id/method/:storage_method/keyframes/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

asset_idstring required

storage_methodstring required

Query parameters

use_google_resumable_uploadboolean

Set to True to get a google resumable upload link

Headers

App-IDstring required

Auth-Tokenstring required

Request body

asset_idstring uuid nullable

collection_idstring uuid nullable

content_typestring

date_createdstring date-time

date_modifiedstring date-time

filenamestring

formatstring nullable

idstring uuid

is_custom_keyframeboolean

is_publicboolean

namestring

rotationinteger nullable

sizeinteger nullable

storage_idstring uuid

storage_methodstring

type'KEYFRAME_MAP' | 'KEYFRAME' | 'POSTER' required

upload_credentialsobject

upload_headersobject

upload_methodstring

upload_urlstring

urlstring

version_idstring uuid nullable

Response

Returns a keyframe that was created for this asset