--- title: "List of segments" method: GET path: "/v1/assets/{asset_id}/segments/" --- # List of segments `GET /v1/assets/{asset_id}/segments/` ## Request - Base URL: `https://app.iconik.io/API/assets` - URL: `https://app.iconik.io/API/assets/v1/assets/{asset_id}/segments/` - 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_read_segments ## Path parameters - `asset_id` string, required ## Query parameters - `sort` string - `ids` string - `query` string - `includes` string - `per_page` integer - `page` integer - `scroll` boolean - `scroll_id` string - `transcription_id` string - `version_id` string - `segment_type` string - `segment_color` string - `time_start_milliseconds` integer - `time_end_milliseconds` integer - `time_start_milliseconds__gte` integer - `time_end_milliseconds__lte` integer - `status` string - `person_id` string - `share_id` string - `project_id` string - `include_users` boolean - `include_all_versions` boolean ## Headers - `App-ID` string, required - `Auth-Token` string, required ## Response `200` Returns a list of segments - SegmentsSchema - `facets` object - `first_url` string - `last_url` string - `next_url` string - `objects` SegmentElasticSchema[] - `asset_id` string, uuid - `attachments` object[] - `date_created` string, date-time - `date_modified` string, date-time - `drawing` DrawingSchema - `primitives` DrawingPrimitiveSchema[] - `color` string - `opacity` number - `points` DrawingPointSchema[] - `x` number, required - `y` number, required - `text` string - `type` 'LINE' | 'RECTANGLE' | 'ARROW' | 'ELLIPSE' | 'PENCIL' | 'TEXT' | 'CROSS', required - `width` number - `version` integer, nullable - `external_id` string, nullable - `face_bounding_boxes` FaceBoundingBoxSchema[], nullable - `bounding_box` number[] - `landmarks` FaceLandmark[], nullable - `x` number, required - `y` number, required - `person_version_face_id` string, uuid, required - `timestamp_ms` integer - `has_attachments` boolean - `has_drawing` boolean - `id` string, uuid - `is_internal` boolean, nullable: If set to true, the segment is only visible to internal iconik users - `keyframe_id` string, uuid, nullable - `metadata` object - `metadata_view_id` string, uuid, nullable - `parent_id` string, uuid - `path` string - `person_id` string, uuid, nullable - `project_id` string, uuid, nullable: ID of a project if the segment is created from a project - `segment_checked` boolean - `segment_color` string - `segment_text` string, nullable - `segment_track` string, nullable - `segment_type` 'MARKER' | 'QC' | 'GENERIC' | 'COMMENT' | 'TAG' | 'TRANSCRIPTION' | 'SCENE' | 'SHOT' | 'PERSON' | 'SEMANTIC_TRANSCRIPTION', required - `semantic_transcription` SemanticTranscription - `cut_reasons` string[], nullable - `embedding` string, nullable - `embedding_dim` integer, nullable - `embedding_encoding` string, nullable - `embedding_model` string, nullable - `embedding_model_version` string, nullable - `entities` SemanticTranscriptionEntity[], nullable - `label` string, nullable - `text` string, required - `language` string, nullable - `speaker_count` string, nullable - `tone` string, nullable - `topics` UnderstandingTag[], nullable - `label` string, required - `level` string, nullable - `score` number, nullable - `track_id` string, nullable - `valence` string, nullable - `share_id` string, uuid, nullable: ID of a share if the segment is created from a share - `share_session_id` string, uuid, nullable - `share_user_email` string, email, nullable - `shot` Shot - `actions` UnderstandingTag[], nullable - `label` string, required - `level` string, nullable - `score` number, nullable - `animal_species` UnderstandingTag[], nullable - `label` string, required - `level` string, nullable - `score` number, nullable - `brand_logo` UnderstandingTag[], nullable - `label` string, required - `level` string, nullable - `score` number, nullable - `camera_angle` UnderstandingTag - `label` string, required - `level` string, nullable - `score` number, nullable - `caption` string, nullable - `color_palette` UnderstandingTag[], nullable - `label` string, required - `level` string, nullable - `score` number, nullable - `composition` string, nullable - `dog_breeds` UnderstandingTag[], nullable - `label` string, required - `level` string, nullable - `score` number, nullable - `dominant_hue` string, nullable - `embedding` string, nullable - `embedding_dim` integer, nullable - `embedding_encoding` string, nullable - `embedding_model` string, nullable - `embedding_model_version` string, nullable - `facial_expression` UnderstandingTag[], nullable - `label` string, required - `level` string, nullable - `score` number, nullable - `keyframe_ts` integer - `light_key` string, nullable - `light_side` string, nullable - `light_style` string[], nullable - `light_time` string, nullable - `mood` UnderstandingTag[], nullable - `label` string, required - `level` string, nullable - `score` number, nullable - `mood_valence` string, nullable - `movement` string[], nullable - `objects` UnderstandingTag[], nullable - `label` string, required - `level` string, nullable - `score` number, nullable - `ocr_text` string, nullable - `orientation` string, nullable - `people_age_range` string[], nullable - `people_bucket` string, nullable - `people_count` integer, nullable - `people_features` UnderstandingTag[], nullable - `label` string, required - `level` string, nullable - `score` number, nullable - `people_gender` string[], nullable - `place` UnderstandingTag - `label` string, required - `level` string, nullable - `score` number, nullable - `resolution` string, nullable - `scale_rank` integer, nullable - `season` UnderstandingTag - `label` string, required - `level` string, nullable - `score` number, nullable - `sensitive_content` UnderstandingTag[], nullable - `label` string, required - `level` string, nullable - `score` number, nullable - `setting` UnderstandingTag - `label` string, required - `level` string, nullable - `score` number, nullable - `shot_scale` UnderstandingTag - `label` string, required - `level` string, nullable - `score` number, nullable - `sport_type` UnderstandingTag - `label` string, required - `level` string, nullable - `score` number, nullable - `subject_type` UnderstandingTag[], nullable - `label` string, required - `level` string, nullable - `score` number, nullable - `time_of_day` string, nullable - `track_id` string, nullable - `weather` UnderstandingTag - `label` string, required - `level` string, nullable - `score` number, nullable - `status` 'ACTIVE' | 'DELETED' | 'AWAITED' - `subclip_id` string, uuid - `time_end_milliseconds` integer, nullable - `time_start_milliseconds` integer, nullable - `top_level` boolean - `transcription` TranscriptionType - `speaker` integer, nullable - `words` TranscriptionElementType[], required - `end_ms` integer, required - `score` number - `start_ms` integer, required - `value` string, required - `transcription_id` string, uuid, nullable - `user_first_name` string - `user_id` string, uuid - `user_info` User - `email` string, email - `first_name` string - `id` string, uuid - `last_name` string - `photo` string - `photo_big` string - `photo_small` string - `user_last_name` string - `user_photo` string - `version_id` string, uuid - `page` integer - `pages` integer - `per_page` integer - `prev_url` string - `scroll_id` string - `search_after` unknown[] - unknown - `total` integer ## Other responses - `400`: Bad request - `401`: Token is invalid - `404`: Page number 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)