--- title: "Update asset" method: PATCH path: "/v1/assets/{asset_id}/" --- # Update asset `PATCH /v1/assets/{asset_id}/` ## Request - Base URL: `https://app.iconik.io/API/assets` - URL: `https://app.iconik.io/API/assets/v1/assets/{asset_id}/` - Auth: none declared. Required headers: `App-ID`, `Auth-Token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Required roles: - can_write_assets ## Path parameters - `asset_id` string, required ## Query parameters - `generate_subclip_keyframes` boolean - `low_priority_indexing` boolean ## Headers - `App-ID` string, required - `Auth-Token` string, required ## Request body - union - AssetSchema - `analyze_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `archive_status` 'NOT_ARCHIVED' | 'ARCHIVING' | 'FAILED_TO_ARCHIVE' | 'ARCHIVED' - `category` string, nullable - `clip_id` integer, nullable: ID of the draft clip in the Wildmoka system that is linked to this asset. - `created_by_user` string, uuid - `created_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `custom_keyframe` string, uuid, nullable - `custom_poster` string, uuid, nullable - `date_created` string, date-time - `date_deleted` string, date-time - `date_imported` string, date-time - `date_modified` string, date-time - `date_viewed` string, date-time - `deleted_by_user` string, uuid - `deleted_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `external_id` string, nullable - `external_link` string, url, nullable - `face_recognition_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `favoured` boolean - `has_unconfirmed_persons` boolean - `id` string, uuid - `in_collections` string[] - `is_blocked` boolean - `is_online` boolean - `last_archive_restore_date` string, date-time - `limit_download_to_groups` string[], nullable - `original_asset_id` string, uuid - `original_segment_id` string, uuid - `original_version_id` string, uuid - `person_ids` string[], nullable - `site_name` string, nullable - `status` 'ACTIVE' | 'DELETED' - `time_end_milliseconds` integer - `time_start_milliseconds` integer - `title` string, required - `type` 'ASSET' | 'SEQUENCE' | 'NLE_PROJECT' | 'PLACEHOLDER' | 'CUSTOM' | 'LINK' | 'SUBCLIP' - `updated_by_user` string, uuid - `updated_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `versions` AssetVersion[] - `analyze_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `archive_status` 'NOT_ARCHIVED' | 'ARCHIVING' | 'FAILED_TO_ARCHIVE' | 'ARCHIVED' - `created_by_user` string, uuid - `created_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `date_created` string, date-time - `face_recognition_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `has_unconfirmed_persons` boolean - `id` string, uuid - `is_online` boolean - `person_ids` string[] - `status` 'ACTIVE' | 'IN_PROGRESS' | 'FAILED' | 'DELETING' | 'DELETED' - `transcribe_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `transcribed_languages` string[] - `version_number` integer - `warning` string, nullable - AssetPostSchema - `analyze_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `archive_status` 'NOT_ARCHIVED' | 'ARCHIVING' | 'FAILED_TO_ARCHIVE' | 'ARCHIVED' - `category` string, nullable - `clip_aspect_ratio` string, nullable - `clip_duration` number, nullable - `clip_id` integer, nullable - `clip_mime_type` string, nullable - `created_by_user` string, uuid - `created_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `custom_keyframe` string, uuid, nullable - `custom_poster` string, uuid, nullable - `date_created` string, date-time - `date_deleted` string, date-time - `date_imported` string, date-time - `date_modified` string, date-time - `date_published_at` string, date-time - `date_viewed` string, date-time - `deleted_by_user` string, uuid - `deleted_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `destination_icon` string, nullable - `destination_name` string, nullable - `destination_picture` string, nullable - `destination_type` string, nullable - `external_id` string, nullable - `external_link` string, url, nullable - `face_recognition_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `favoured` boolean - `has_unconfirmed_persons` boolean - `id` string, uuid - `in_collections` string[] - `is_blocked` boolean - `is_online` boolean - `last_archive_restore_date` string, date-time - `likes` integer, nullable - `limit_download_to_groups` string[], nullable - `original_asset_id` string, uuid - `original_segment_id` string, uuid - `original_version_id` string, uuid - `person_ids` string[], nullable - `publication_id` integer, nullable - `publication_metadata` object, nullable - `publication_status` 'CANCELED' | 'FAILED' | 'PUBLISHED' | 'PUBLISHED_WITH_WARNING' | 'RUNNING' | 'SCHEDULED' - `site_name` string, nullable - `status` 'ACTIVE' | 'DELETED' - `time_end_milliseconds` integer - `time_start_milliseconds` integer - `title` string, required - `type` 'POST' - `updated_by_user` string, uuid - `updated_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `versions` AssetVersion[] - `analyze_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `archive_status` 'NOT_ARCHIVED' | 'ARCHIVING' | 'FAILED_TO_ARCHIVE' | 'ARCHIVED' - `created_by_user` string, uuid - `created_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `date_created` string, date-time - `face_recognition_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `has_unconfirmed_persons` boolean - `id` string, uuid - `is_online` boolean - `person_ids` string[] - `status` 'ACTIVE' | 'IN_PROGRESS' | 'FAILED' | 'DELETING' | 'DELETED' - `transcribe_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `transcribed_languages` string[] - `version_number` integer - `views` integer, nullable - `warning` string, nullable ## Response `200` Returns an updated asset - union - AssetSchema - `analyze_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `archive_status` 'NOT_ARCHIVED' | 'ARCHIVING' | 'FAILED_TO_ARCHIVE' | 'ARCHIVED' - `category` string, nullable - `clip_id` integer, nullable: ID of the draft clip in the Wildmoka system that is linked to this asset. - `created_by_user` string, uuid - `created_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `custom_keyframe` string, uuid, nullable - `custom_poster` string, uuid, nullable - `date_created` string, date-time - `date_deleted` string, date-time - `date_imported` string, date-time - `date_modified` string, date-time - `date_viewed` string, date-time - `deleted_by_user` string, uuid - `deleted_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `external_id` string, nullable - `external_link` string, url, nullable - `face_recognition_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `favoured` boolean - `has_unconfirmed_persons` boolean - `id` string, uuid - `in_collections` string[] - `is_blocked` boolean - `is_online` boolean - `last_archive_restore_date` string, date-time - `limit_download_to_groups` string[], nullable - `original_asset_id` string, uuid - `original_segment_id` string, uuid - `original_version_id` string, uuid - `person_ids` string[], nullable - `site_name` string, nullable - `status` 'ACTIVE' | 'DELETED' - `time_end_milliseconds` integer - `time_start_milliseconds` integer - `title` string, required - `type` 'ASSET' | 'SEQUENCE' | 'NLE_PROJECT' | 'PLACEHOLDER' | 'CUSTOM' | 'LINK' | 'SUBCLIP' - `updated_by_user` string, uuid - `updated_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `versions` AssetVersion[] - `analyze_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `archive_status` 'NOT_ARCHIVED' | 'ARCHIVING' | 'FAILED_TO_ARCHIVE' | 'ARCHIVED' - `created_by_user` string, uuid - `created_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `date_created` string, date-time - `face_recognition_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `has_unconfirmed_persons` boolean - `id` string, uuid - `is_online` boolean - `person_ids` string[] - `status` 'ACTIVE' | 'IN_PROGRESS' | 'FAILED' | 'DELETING' | 'DELETED' - `transcribe_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `transcribed_languages` string[] - `version_number` integer - `warning` string, nullable - AssetPostSchema - `analyze_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `archive_status` 'NOT_ARCHIVED' | 'ARCHIVING' | 'FAILED_TO_ARCHIVE' | 'ARCHIVED' - `category` string, nullable - `clip_aspect_ratio` string, nullable - `clip_duration` number, nullable - `clip_id` integer, nullable - `clip_mime_type` string, nullable - `created_by_user` string, uuid - `created_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `custom_keyframe` string, uuid, nullable - `custom_poster` string, uuid, nullable - `date_created` string, date-time - `date_deleted` string, date-time - `date_imported` string, date-time - `date_modified` string, date-time - `date_published_at` string, date-time - `date_viewed` string, date-time - `deleted_by_user` string, uuid - `deleted_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `destination_icon` string, nullable - `destination_name` string, nullable - `destination_picture` string, nullable - `destination_type` string, nullable - `external_id` string, nullable - `external_link` string, url, nullable - `face_recognition_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `favoured` boolean - `has_unconfirmed_persons` boolean - `id` string, uuid - `in_collections` string[] - `is_blocked` boolean - `is_online` boolean - `last_archive_restore_date` string, date-time - `likes` integer, nullable - `limit_download_to_groups` string[], nullable - `original_asset_id` string, uuid - `original_segment_id` string, uuid - `original_version_id` string, uuid - `person_ids` string[], nullable - `publication_id` integer, nullable - `publication_metadata` object, nullable - `publication_status` 'CANCELED' | 'FAILED' | 'PUBLISHED' | 'PUBLISHED_WITH_WARNING' | 'RUNNING' | 'SCHEDULED' - `site_name` string, nullable - `status` 'ACTIVE' | 'DELETED' - `time_end_milliseconds` integer - `time_start_milliseconds` integer - `title` string, required - `type` 'POST' - `updated_by_user` string, uuid - `updated_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `versions` AssetVersion[] - `analyze_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `archive_status` 'NOT_ARCHIVED' | 'ARCHIVING' | 'FAILED_TO_ARCHIVE' | 'ARCHIVED' - `created_by_user` string, uuid - `created_by_user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `date_created` string, date-time - `face_recognition_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `has_unconfirmed_persons` boolean - `id` string, uuid - `is_online` boolean - `person_ids` string[] - `status` 'ACTIVE' | 'IN_PROGRESS' | 'FAILED' | 'DELETING' | 'DELETED' - `transcribe_status` 'N/A' | 'REQUESTED' | 'IN_PROGRESS' | 'FAILED' | 'DONE' - `transcribed_languages` string[] - `version_number` integer - `views` integer, nullable - `warning` string, nullable ## Other responses - `400`: Bad request - `401`: Token is invalid - `403`: Permission denied, changing a subclip's time range requires can_create_subclips - `404`: Asset does not exist - `default`: Error response --- [API](https://skmtc.dev/iconik/apis/iconik-assets.md) - [All operations](https://skmtc.dev/iconik/apis/iconik-assets/llms.txt) - [OpenAPI document](https://skmtc.dev/iconik/apis/iconik-assets/revisions/62580d9e640e?raw)