Create keyframe and associate to collection

Required roles:

can_write_keyframes

post/v1/collections/{collection_id}/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/collections/:collection_id/keyframes/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

collection_idstring required

Headers

App-IDstring required

Auth-Tokenstring required

Request body

collection_idstring uuid

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

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

upload_credentialsobject

upload_headersobject

upload_methodstring

upload_urlstring

urlstring

Response

Returns a keyframe that was created for this collection