---
title: "Update existing item."
method: PUT
path: "/api/v2/teams/{team_slug}/items/{item_id}"
tags: ["Items"]
---

# Update existing item.

`PUT /api/v2/teams/{team_slug}/items/{item_id}`

You can not update deleted item. Item name should not contain `/`. We do not accept items with the same name in given path and dataset.

## Path parameters

- `team_slug` string, required
- `item_id` string, uuid, required

## Request body

- DatasetsV2ItemManagementItemUpdateRequest — Update existing item.
  - `name` string, required — Name of the Item.

## Response `200`

DatasetsV2.ItemManagement.Item

- DatasetsV2ItemManagementItem
  - `archived` boolean, required
  - `cursor` string
  - `dataset_id` integer, required
  - `id` string, uuid, required
  - `inserted_at` string, date-time, required — Date and time when the item was inserted.
  - `layout` union
    - object — Object describing Item's layout. Version 3.
      - `slots_grid` array[], required — 3D grid of slots. Max dimensions are 4x4x128.
        - DatasetsV2CommonSlotsGridCell[] — Grid's row.
          - union
            - string — 'ID' of the Slot to identify it within the Item. It's recommended to use numeric values satarting with 1.
            - DatasetsV2CommonSlotName[] — Stack of slots representing different layers of the same media file.
      - `version` 3, required — Layout version.
    - object — Object describing Item's layout. Version 2.
      - `layout_shape` integer[]
      - `slots` DatasetsV2CommonSlotName[], required
      - `type` 'grid' | 'horizontal' | 'vertical' | 'simple', required — View type.
      - `version` 2, required — Layout version.
    - object — Object describing Item's layout. Version 1.
      - `slots` DatasetsV2CommonSlotName[], required
      - `type` 'grid' | 'horizontal' | 'vertical' | 'simple', required — View type.
      - `version` 1, required — Layout version.
  - `name` string, required — Name of the Item.
  - `path` string, required — Path under which Item should be added to on Darwin platform. Should always be absolute.
  - `priority` integer, required
  - `processing_status` 'cancelled' | 'error' | 'uploading' | 'upload_confirmed' | 'processing' | 'complete', required — Current processing status of the Upload/Item.
  - `slot_types` DatasetsV2CommonSlotType[], required
  - `slots` DatasetsV2ItemManagementSlot[], required
    - `available_quality_presets` DatasetsV2ItemManagementStreamQualityPreset[] — List of available quality presets for this slot. See `/api/v2/teams/:team_slug/:item_id/slots/:slot_name/stream/:quality/sign`.
      - `bitrate` integer
      - `name` 'low' | 'medium' | 'high', required — Name of the quality preset.
    - `dicom_json_url` string — URL to the DICOM JSON for this Slot. In order to get this please use `include_dicom_json=true` in the request
    - `file_name` string, required — Name of the File. This will be included in exports for easier Item tracking.
    - `first_section_url` string — URL section of the Slot. In order to get this please use `include_first_sections=true` in the request.
    - `fps` number — Framerate which Darwin should extract frames at.
    - `id` string, uuid, required
    - `is_external` boolean, required — Whether the slot is on external storage or not.
    - `metadata` DatasetsV2ItemManagementMetadata — Metadata associated with the Slot.
    - `sectionless` boolean — A flag indicating if the slot has any real sections.
    - `size_bytes` integer — Size of the slot in bytes.
    - `slot_name` string, required — 'ID' of the Slot to identify it within the Item. It's recommended to use numeric values satarting with 1.
    - `streamable` boolean — Whether slot can be streamed or not. See `/api/v2/teams/:team_slug/:item_id/slots/:slot_name/stream/sign`.
    - `thumbnail_url` string — URL to thumbnail of the Slot. In order to get this please use `include_thumbnails=true` in the request.
    - `total_sections` integer, required — Number of all sections (frames/pages etc) of the Slot. In case of sectionless Slot, this number holds the 'virtual' number of total sections.
    - `type` 'image' | 'video' | 'pdf' | 'dicom', required — When type is ommited, it's gonna be infered from the slot's extension if possible.
    - `upload_id` string, uuid, required
  - `status` 'error' | 'uploading' | 'processing' | 'archived' | 'new' | 'annotate' | 'review' | 'complete', required — General status of the Upload/Item. It considers processing status as well as workflow status and Item being archived/non-archived. Can be used instead of 'processing_status' and 'workflow_status' for simplicity. Item will be marked as 'complete' only if both workflow and processing is done.
  - `tags` DatasetsV2ItemManagementItemTagType[]
  - `updated_at` string, date-time, required — Date and time when the item was recently updated.
  - `uploads` DatasetsV2ItemManagementUpload[], required
    - `as_frames` boolean — When set, processes the video as individual frames creating Item for each frame.
    - `file_name` string, required — Name of the File. This will be included in exports for easier Item tracking.
    - `fps` union — Framerate which Darwin should extract frames at. Should be either positive number or string 'native'.
      - 'native' — Instructs Darwin that it should extract frames at native framerate.
      - number — Framerate which Darwin should extract frames at.
    - `processing_error` DatasetsV2CommonProcessingError, nullable — Description of the error that occurred while processing the Upload/Item.
      - `http_status_code` integer, nullable — The HTTP error code, if this error is of type 'http'.
      - `message` string, required — Human readable message of the error.
      - `raw_error` string, nullable — The raw body of the error.The format and contents of this field depend both the type of error that occurred and on the provider giving the external storage service.
      - `stage` 'download' | 'extract' | 'upload', required — The stage of processing at which this error occurred.
      - `storage_key` string, nullable — Storage key (path) of the file that cause the error.
      - `type` 'http' | 'unknown' | 'timeout' | 'custom', required — The type of the error that occurred.
    - `processing_status` 'cancelled' | 'error' | 'uploading' | 'upload_confirmed' | 'processing' | 'complete', required — Current processing status of the Upload/Item.
    - `slot_name` string, required — 'ID' of the Slot to identify it within the Item. It's recommended to use numeric values satarting with 1.
    - `type` 'image' | 'video' | 'pdf' | 'dicom', required — When type is ommited, it's gonna be infered from the slot's extension if possible.
    - `upload_id` string, uuid, required
  - `workflow_data` DatasetsV2ItemManagementWorkflowData, nullable
    - `current_stage_instances` DatasetsV2ItemManagementWorkflowDataStageInstance[], required — List of 'current' stage instances for this item. Each entry on that list will have status: 'current'.
      - `active_edge` string, nullable, required
      - `assignee_id` integer, nullable, required — Item's assignee ID (of current stage)
      - `delete_annotations_snapshot_id` string, uuid, nullable, required
      - `exit_snapshot_id` string, uuid, nullable, required
      - `parent_stage_id` string, uuid, nullable, required
      - `skipped` boolean, required
      - `skipped_reason` string, nullable
      - `stage_id` string, uuid, nullable, required
      - `stage_type` 'annotate' | 'complete' | 'consensus_entrypoint' | 'consensus_test' | 'dataset' | 'discard' | 'model' | 'review' | 'webhook' | 'archive' | 'logic' | 'sampling' | 'parallel_blind' | 'ai_review', required
    - `workflow_id` string, uuid, nullable
  - `workflow_status` 'new' | 'annotate' | 'review' | 'complete', nullable, required — Current workflow status of the Upload/Item.

## Other responses

- `401` — Common.APIError
- `404` — Common.APIError
- `422` — Unprocessible Entity

---

[API](https://skmtc.net/v7labs/apis/darwin.md) · [All operations](https://skmtc.net/v7labs/apis/darwin/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/v7labs/darwin/versions/526a5b6b4cdc/schema)