> ## Documentation Index
> Fetch the complete documentation index at: https://docs.encord.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Orm.storage

## StorageItemType Objects

```python theme={"dark"}
class StorageItemType(CamelStrEnum)
```

Type of item stored in Encord storage.

**Values:**

* **VIDEO:** A video file.
* **IMAGE:** A single image.
* **GROUP:** A generic grouped item.
* **IMAGE\_GROUP:** A group of images treated as a single item.
* **IMAGE\_SEQUENCE:** An image sequence backed by a video or ordered frames.
* **DICOM\_FILE:** A single DICOM file.
* **DICOM\_SERIES:** A DICOM series composed of multiple DICOM files.
* **AUDIO:** An audio file.
* **TIME\_SERIES:** A time series file.
* NIFTI:\*\* A NIFTI volume.
* **PLAIN\_TEXT:** A text file (for example TXT, HTML, JSON).
* **PDF:** A PDF document.
* **SCENE:** A scene. For example, a single point cloud data file or a composition of multiple assets like videos and point cloud data files.

## StorageUserRole Objects

```python theme={"dark"}
class StorageUserRole(CamelStrEnum)
```

Role of a user in the context of a storage folder or item.

**Values:**

* **USER:** Standard user with access to the item.
* **ADMIN:** User with administrative privileges on the item.

## StorageLocationName Objects

```python theme={"dark"}
class StorageLocationName(CamelStrEnum)
```

Storage backends supported by Encord.

**Values:**

* **ENCORD:** Encord-managed storage.
* **GCP:** Google Cloud Storage.
* **S3:** Amazon S3.
* **AZURE:** Azure Blob Storage.
* **OPEN\_TELEKOM:** Open Telekom Cloud (legacy alias, superseded by S3\_COMPATIBLE).
* **DIRECT\_ACCESS:** Direct-access storage.
* **S3\_COMPATIBLE:** Generic S3-compatible storage backend.

#### OPEN\_TELEKOM

TODO: Remove when enough people have updated their sdk to include S3\_COMPATIBLE below

## PathElement Objects

```python theme={"dark"}
class PathElement(BaseDTO)
```

Single step in the path from a storage folder to the root.

**Arguments**:

* `uuid` - UUID of this path element (folder).
* `parent_uuid` - UUID of the parent path element, if any.
* `name` - Name of the folder.
* `synced_dataset_hash` - UUID of the dataset that is synced with this folder, if any.

## StorageFolder Objects

```python theme={"dark"}
class StorageFolder(BaseDTO)
```

Folder in Encord storage.

**Arguments**:

* `uuid` - UUID of the folder.
* `parent` - UUID of the parent folder, if any.
* `name` - Name of the folder.
* `description` - Optional description of the folder.
* `client_metadata` - Optional custom metadata associated with the folder.
* `owner` - Email or identifier of the folder owner.
* `created_at` - Timestamp when the folder was created.
* `last_edited_at` - Timestamp when the folder was last modified.
* `user_role` - Role of the current user in this folder.
* `synced_dataset_hash` - UUID of the dataset synced with this folder, if any.
* `path_to_root` - Path from this folder to the root, represented as a list
  of [PathElement](/sdk-documentation/sdk-references/orm.storage#pathelement) instances.

## StorageItem Objects

```python theme={"dark"}
class StorageItem(BaseDTO)
```

Item in Encord storage (file, group, DICOM series, etc.).

**Arguments**:

* `uuid` - UUID of the storage item.
* `parent` - UUID of the parent folder containing this item.
* `item_type` - Type of the storage item (video, image, group, etc.).
* `name` - Name of the item.
* `description` - Optional description of the item.
* `client_metadata` - Optional custom metadata associated with the item.
* `owner` - Email or identifier of the item owner.
* `created_at` - Timestamp when the item was created.
* `last_edited_at` - Timestamp when the item was last modified.
* `is_tombstone` - This item has been deleted but the link is retained for consistency reasons.
  Mostly for items in the 'cloud linked folders' that are referenced but aren't present after a re-sync.
* `is_placeholder` - This item has been added to the folder but isn't fully processed yet.
* `backed_data_units_count` - Number of data units backed by this storage item.
* `storage_location` - Storage backend where the item resides.
* `integration_hash` - UUID of the integration used for this item, if any.
* `url` - Raw URL of the storage object, if available.
* `signed_url` - Signed URL for temporary access to the storage object.
* `file_size` - Size of the file in bytes, if known.
* `mime_type` - MIME type of the file, if known.
* `duration` - Duration in seconds (for temporal media), if known.
* `fps` - Frame rate value (for video), if known.
* `height` - Height in pixels (for image/video), if known.
* `width` - Width in pixels (for image/video), if known.
* `dicom_instance_uid` - DICOM instance UID, if applicable.
* `dicom_study_uid` - DICOM study UID, if applicable.
* `dicom_series_uid` - DICOM series UID, if applicable.
* `frame_count` - Number of frames for multi-frame media, if known.
* `audio_sample_rate` - Sample rate of the audio track in Hz, if known.
* `audio_bit_depth` - Bit depth of the audio track, if known.
* `audio_codec` - Codec name of the audio track, if known.
* `audio_num_channels` - Number of audio channels, if known.

## StorageItemWithClientMetadataSignedUrl Objects

```python theme={"dark"}
class StorageItemWithClientMetadataSignedUrl(StorageItem)
```

`StorageItem` plus the signed URL the backend returns when `client_metadata_as_signed_url` is requested.

When that flag is set, the server delivers `client_metadata` as a signed URL pointing at the
bucket-stored blob (and leaves `client_metadata` itself empty) instead of in-lining it. This
subclass is an internal carrier for that one extra field: the SDK fetches the URL and in-lines
the result, so callers only ever see resolved `client_metadata`. It is never exposed on a
public return type.

## StorageItemInaccessible Objects

```python theme={"dark"}
class StorageItemInaccessible(BaseDTO)
```

Stub object used when a storage item is inaccessible.

**Arguments**:

uuid:
UUID of the item that cannot be accessed.

## CloudSyncedFolderParams Objects

```python theme={"dark"}
class CloudSyncedFolderParams(BaseDTO)
```

Parameters for creating a cloud-synced folder in Encord storage.

A cloud-synced folder maintains synchronization link between an Encord
storage folder and an external cloud storage location (bucket/folder). This allows you to
manage files in your preferred cloud provider while making them available for use in Encord.

#### integration\_uuid

UUID of the cloud storage integration to use.

This UUID refers to a preconfigured integration in Encord that contains
authentication credentials and settings for a cloud storage provider.
The integration must be set up in the Encord platform before creating
a cloud-synced folder.

#### remote\_url

URL or path to the cloud storage location to sync with.

The format depends on the cloud storage provider:

* Amazon S3: "s3://bucket-name/path/"
* Google Cloud Storage: "gs\://bucket-name/path/"
* Azure Blob Storage: "[https://account.blob.core.windows.net/container/path/](https://account.blob.core.windows.net/container/path/)"
* S3-compatible services: "[https://endpoint/bucket-name/path/](https://endpoint/bucket-name/path/)"

The folder will be synced recursively, and all supported file types
will be imported into Encord.

## CreateStorageFolderPayload Objects

```python theme={"dark"}
class CreateStorageFolderPayload(BaseDTO)
```

Payload for creating a storage folder.

**Arguments**:

* `name` - Name of the new folder.
* `description` - Optional description of the folder.
* `parent` - UUID of the parent folder under which to create this folder.
* `client_metadata` - Optional custom metadata associated with the folder.
* `cloud_synced_folder_params` - Optional configuration for creating a cloud-synced folder
  that is linked to an external storage location.

## DataGroupGrid Objects

```python theme={"dark"}
class DataGroupGrid(BaseDTO)
```

Grid-based layout for a data group.

**Arguments**:

* `layout_contents` - Ordered list of item UUIDs to display in the grid.
* `name` - Optional name of the data group.
* `client_metadata` - Optional custom metadata to associate with the data group.

## DataGroupCarousel Objects

```python theme={"dark"}
class DataGroupCarousel(BaseDTO)
```

Carousel layout for a data group.

**Arguments**:

* `layout_contents` - Ordered list of item UUIDs to display in the carousel.
* `name` - Optional name of the data group.
* `client_metadata` - Optional custom metadata to associate with the data group.

## DataGroupList Objects

```python theme={"dark"}
@deprecated(version=None, alternative="DataGroupCarousel")
class DataGroupList(DataGroupCarousel)
```

Deprecated, will be removed in a future release. Use `DataGroupCarousel` instead.

## DataGroupCustom Objects

```python theme={"dark"}
class DataGroupCustom(BaseDTO)
```

Custom layout for a data group.

**Arguments**:

* `name` - Optional name of the data group.
* `layout_contents` - Mapping from arbitrary keys to item UUIDs.
* `layout` - Arbitrary layout configuration structure.
* `settings` - Optional extra settings for the layout.
* `client_metadata` - Optional custom metadata to associate with the data group.

## CreateDataGroupsResponse Objects

```python theme={"dark"}
class CreateDataGroupsResponse(RootModelDTO[List[UUID]])
```

Response returned after creating multiple data groups.

The root value is a list of UUIDs of the created data group storage items.

## UploadSignedUrlsPayload Objects

```python theme={"dark"}
class UploadSignedUrlsPayload(BaseDTO)
```

Request payload for generating signed URLs for uploads.

**Arguments**:

* `item_type` - Type of storage item that will be uploaded.
* `count` - Number of signed URLs to generate.
* `frames_subfolder_name` - Optional subfolder name to use for frame-based uploads.

## UploadSignedUrl Objects

```python theme={"dark"}
class UploadSignedUrl(BaseDTO)
```

Single signed URL returned for an upload.

**Arguments**:

* `item_uuid` - UUID of the placeholder storage item to be filled.
* `object_key` - Object key or path in the underlying storage backend.
* `signed_url` - Signed URL that can be used to upload the content.
* `upload_headers` - HTTP headers that must be sent with the PUT to
  `signed_url`. Empty for S3/GCP; Azure block-blob uploads require
* `{"x-ms-blob-type": "BlockBlob"}`. The SDK applies these verbatim
  so the upload contract stays cloud-agnostic.

## StorageItemWithName Objects

```python theme={"dark"}
class StorageItemWithName(BaseDTO)
```

Storage item reference with a resolved name.

**Arguments**:

* `item_uuid` - UUID of the storage item.
* `name` - Display name of the item.

## UploadLongPollingState Objects

```python theme={"dark"}
class UploadLongPollingState(BaseDTO)
```

Response of the upload job's long polling request.

Note: An upload job consists of job units, where job unit could be
either a video, image group, dicom series, or a single image.

#### status

Status of the upload job. Documented in detail in [LongPollingStatus()](/sdk-documentation/sdk-references/orm.dataset#longpollingstatus)

#### items\_with\_names

Information about data which was added to the folder.

#### errors

Stringified list of exceptions.

#### units\_pending\_count

Number of upload job units that have pending status.

#### units\_done\_count

Number of upload job units that have done status.

#### units\_error\_count

Number of upload job units that have error status.

#### units\_cancelled\_count

Number of upload job units that have been canceled.

#### unit\_errors

Structured list of per-item upload errors. See [DataUnitError](/sdk-documentation/sdk-references/orm.dataset#datauniterror) for more details.

#### file\_name

Name of the JSON or CSV file that contained the list of URLs to ingest form the cloud bucket. Optional.

## CustomerProvidedImageMetadata Objects

```python theme={"dark"}
class CustomerProvidedImageMetadata(BaseDTO)
```

Media metadata for an image file; if provided, Encord service will use the values here instead of scanning the files

#### mime\_type

MIME type of the image file (e.g. `image/jpeg` or `image/png`).

#### file\_size

Size of the image file in bytes.

#### height

Height of the image in pixels.

#### width

Width of the image in pixels.

## CustomerProvidedVideoMetadata Objects

```python theme={"dark"}
class CustomerProvidedVideoMetadata(BaseDTO)
```

Media metadata for a video file; if provided, Encord service will skip frame synchronization checks
and will use the values specified here to render the video in the label editor.

#### fps

Frame rate of the video in frames per second.

#### duration

Video duration in (float) seconds.

#### width

Width of the video in pixels.

#### height

Height of the video in pixels.

#### file\_size

Size of the video file in bytes.

#### mime\_type

MIME type of the video file (e.g. `video/mp4` or `video/webm`).

## CustomerProvidedAudioMetadata Objects

```python theme={"dark"}
class CustomerProvidedAudioMetadata(BaseDTO)
```

Media metadata for an audio file. The Encord platform uses the specified values instead of scanning the files.

#### duration

Audio duration in (float) seconds.

#### file\_size

Size of the audio file in bytes.

#### mime\_type

MIME type of the audio file (for example: `audio/mpeg` or `audio/wav`).

#### sample\_rate

Sample rate (int) in Hz.

#### bit\_depth

Size of each sample (int) in bits.

#### codec

Codec (for example: mp3, pcm).

#### num\_channels

Number of channels

## CustomerProvidedTextMetadata Objects

```python theme={"dark"}
class CustomerProvidedTextMetadata(BaseDTO)
```

Media metadata for a text file. The Encord platform uses the specified values instead of scanning the files.

#### file\_size

Size of the text file in bytes.

#### mime\_type

MIME type of the text file (for example: `application/json` or `text/plain…`).

## CustomerProvidedPdfMetadata Objects

```python theme={"dark"}
class CustomerProvidedPdfMetadata(BaseDTO)
```

Media metadata for a PDF file. The Encord platform uses the specified values instead of scanning the files.

#### file\_size

Size of the PDF file in bytes.

#### num\_pages

Number of pages in the PDF file.

## CustomerProvidedDicomSeriesDicomFileMetadata Objects

```python theme={"dark"}
class CustomerProvidedDicomSeriesDicomFileMetadata(BaseDTO)
```

Metadata for a DICOM file containing required DICOM tags and their values.
This metadata is used to validate and process DICOM files without needing to access the actual files.

The `tags` dictionary must contain all required DICOM tags as keys, though their corresponding values may be None.
Tags should be provided in the format returned by pydicom to\_json\_dict() method.

Required tags (using standard DICOM tag numbers):

* 00080018: SOPInstanceUID
* 00100020: PatientID
* 00180050: SliceThickness
* 00181114: EstimatedRadiographicMagnificationFactor
* 00181164: ImagerPixelSpacing
* 0020000D: StudyInstanceUID
* 0020000E: SeriesInstanceUID
* 00200013: InstanceNumber
* 00200032: ImagePositionPatient
* 00200037: ImageOrientationPatient
* 00209113: PlanePositionSequence
* 00209116: PlaneOrientationSequence
* 00280004: PhotometricInterpretation
* 00280008: NumberOfFrames
* 00280010: Rows
* 00280011: Columns
* 00280030: PixelSpacing
* 00281050: WindowCenter
* 00281051: WindowWidth
* 00289110: PixelMeasuresSequence
* 52009229: SharedFunctionalGroupsSequence
* 52009230: PerFrameFunctionalGroupsSequence

Missing any of these tags as `tags` dictionary key will raise a validation error.

## DataUploadImage Objects

```python theme={"dark"}
class DataUploadImage(BaseDTO)
```

Data about a single image item to be registered with Encord service.

#### object\_url

"URL of the image file to be registered.

#### title

Title of the image item (derived from the URL if omitted).

#### client\_metadata

Custom metadata to be associated with the image item.

#### external\_file\_type

Type of the external file.

#### image\_metadata

Optional media metadata of the image file (if provided). See [CustomerProvidedImageMetadata](/sdk-documentation/sdk-references/orm.storage#customerprovidedimagemetadata) for more details.

#### placeholder\_item\_uuid

For system use only.

## DataUploadVideo Objects

```python theme={"dark"}
class DataUploadVideo(BaseDTO)
```

Data about a video item to be registered with Encord service.

#### object\_url

URL of the video file to be registered.

#### title

Title of the video item (derived from the URL if omitted).

#### client\_metadata

Custom metadata to be associated with the video item.

#### external\_file\_type

Type of the external file.

#### video\_metadata

Optional media metadata of the video file (if provided). See [CustomerProvidedVideoMetadata](/sdk-documentation/sdk-references/orm.storage#customerprovidedvideometadata) for more details.

#### placeholder\_item\_uuid

For system use only.

## DataUploadNifti Objects

```python theme={"dark"}
class DataUploadNifti(BaseDTO)
```

Data about a NIFTI item to be registered with Encord service.

#### object\_url

URL of the NIFTI file to be registered.

#### title

Title of the NIFTI item (derived from the URL if omitted).

#### client\_metadata

Custom metadata to be associated with the NIFTI item.

#### external\_file\_type

Type of the external file.

#### placeholder\_item\_uuid

For system use only.

## DataUploadImageGroupImage Objects

```python theme={"dark"}
class DataUploadImageGroupImage(BaseDTO)
```

Data about a single image item to be used as a frame in an image group or sequence.

#### url

URL of the image file to be used as the frame in the image group.

#### title

Title of the image item (derived from the URL if omitted).

#### image\_metadata

Optional media metadata of the image file (if provided). See [CustomerProvidedImageMetadata](/sdk-documentation/sdk-references/orm.storage#customerprovidedimagemetadata) for more details.

#### placeholder\_item\_uuid

For system use only.

## DataUploadImageGroup Objects

```python theme={"dark"}
class DataUploadImageGroup(BaseDTO)
```

Data about an image group or image sequence item to be registered with Encord service.

#### images

List of images to be used as frames in the image group. See [DataUploadImageGroupImage](/sdk-documentation/sdk-references/orm.storage#datauploadimagegroupimage) for more details.

#### title

Title of the image group item (required if using cloud integration).

#### client\_metadata

Custom metadata to be associated with the image group item.

#### create\_video

If set to `True`, create an image sequence backed by a video file uploaded to the cloud storage.

#### external\_file\_type

Type of the external file.

## DataUploadImageGroupFromItems Objects

```python theme={"dark"}
class DataUploadImageGroupFromItems(BaseDTO)
```

Data about an image group item to be created from previously uploaded images.

#### image\_items

List of image items to be used as frames in the image group.

#### title

Title of the image group item (required if using cloud integration).

#### client\_metadata

Custom metadata to be associated with the image group.

#### create\_video

If set to `True`, create an image sequence backed by a video file uploaded to the cloud storage.

#### video\_url\_prefix

URL prefix for the video file to be created from the image group.

#### external\_file\_type

Type of the external file.

## DataUploadDicomSeriesDicomFile Objects

```python theme={"dark"}
class DataUploadDicomSeriesDicomFile(BaseDTO)
```

Data about a single DICOM file to be used in a series item.

#### url

URL of the DICOM file to be registered with Encord service.

#### title

Title of the DICOM file (derived from the URL if omitted).

#### dicom\_metadata

Optional media metadata of the DICOM file (if provided). See [CustomerProvidedDicomSeriesDicomFileMetadata](/sdk-documentation/sdk-references/orm.storage#customerprovideddicomseriesdicomfilemetadata) for more details.

#### placeholder\_item\_uuid

For system use only.

## DataUploadDicomSeries Objects

```python theme={"dark"}
class DataUploadDicomSeries(BaseDTO)
```

Data about a DICOM series item to be registered with Encord service.

#### dicom\_files

List of DICOM files to be used in the series item. See [DataUploadDicomSeriesDicomFile](/sdk-documentation/sdk-references/orm.storage#datauploaddicomseriesdicomfile) for more details.

#### title

Title of the DICOM series item (required if using cloud integration).

#### client\_metadata

Custom metadata to be associated with the DICOM series item.

#### external\_file\_type

Type of the external file.

## DataUploadText Objects

```python theme={"dark"}
class DataUploadText(BaseDTO)
```

Data about a text file to be registered with Encord service.

**Arguments**:

* `object_url` - URL of the text (TXT, HTML, etc.) file to be registered.
* `title` - Title of the file (derived from the URL if omitted).
* `client_metadata` - Custom metadata to be associated with the file.
* `external_file_type` - Type of the external file, always `"PLAIN_TEXT"`.
* `text_metadata` - Optional media metadata of the text file. See [CustomerProvidedTextMetadata](/sdk-documentation/sdk-references/orm.storage#customerprovidedtextmetadata) for more details.
* `placeholder_item_uuid` - For system use only.

## DataUploadPDF Objects

```python theme={"dark"}
class DataUploadPDF(BaseDTO)
```

Data about a PDF file to be registered with Encord service.

**Arguments**:

* `object_url` - URL of the PDF file to be registered.
* `title` - Title of the PDF file (derived from the URL if omitted).
* `client_metadata` - Custom metadata to be associated with the file.
* `pdf_metadata` - Optional media metadata of the PDF file. See [CustomerProvidedPdfMetadata](/sdk-documentation/sdk-references/orm.storage#customerprovidedpdfmetadata) for more information.
* `external_file_type` - Type of the external file, always `"PDF"`.
* `placeholder_item_uuid` - For system use only.

## DataUploadAudio Objects

```python theme={"dark"}
class DataUploadAudio(BaseDTO)
```

Data about an audio item to be registered with Encord service.

**Arguments**:

* `object_url` - URL of the audio file to be registered.
* `title` - Title of the audio item (derived from the URL if omitted).
* `client_metadata` - Custom metadata to be associated with the audio item.
* `audio_metadata` - Optional media metadata of the audio file (if provided). See [CustomerProvidedAudioMetadata](/sdk-documentation/sdk-references/orm.storage#customerprovidedaudiometadata) for more details.
* `external_file_type` - Type of the external file, always `"AUDIO"`.
* `placeholder_item_uuid` - For system use only.

## DataUploadScene Objects

```python theme={"dark"}
class DataUploadScene(BaseDTO)
```

Data about a scene item to be registered with Encord service.

#### title

Title of the scene item.

#### scene

Serialized scene payload.

#### client\_metadata

Custom metadata to be associated with the scene item.

#### external\_file\_type

Type of the external file.

#### placeholder\_item\_uuid

For system use only.

## DataUploadItems Objects

```python theme={"dark"}
class DataUploadItems(BaseDTO)
```

A collection of items to be registered with Encord service.

A more structured alternative to using a JSON file.

#### videos

List of video items to be registered. See [DataUploadVideo](/sdk-documentation/sdk-references/orm.storage#datauploadvideo) for more details.

#### image\_groups

List of image group items to be registered. See [DataUploadImageGroup](/sdk-documentation/sdk-references/orm.storage#datauploadimagegroup) for more details.

#### dicom\_series

List of DICOM series items to be registered. See [DataUploadDicomSeries](/sdk-documentation/sdk-references/orm.storage#datauploaddicomseries) for more details.

#### images

List of image items to be registered. See [DataUploadImage](/sdk-documentation/sdk-references/orm.storage#datauploadimage) for more details.

#### image\_groups\_from\_items

List of image group items to be created from previously uploaded images.
See [DataUploadImageGroupFromItems](/sdk-documentation/sdk-references/orm.storage#datauploadimagegroupfromitems) for more details.

#### audio

List of audio items to be registered. See [DataUploadAudio](/sdk-documentation/sdk-references/orm.storage#datauploadaudio) for more details.

#### nifti

List of NIFTI items to be registered. See [DataUploadNifti](/sdk-documentation/sdk-references/orm.storage#datauploadnifti) for more details.

#### text

List of text items to be registered. See [DataUploadText](/sdk-documentation/sdk-references/orm.storage#datauploadtext) for more details.

#### pdf

List of PDF items to be registered. See [DataUploadPDF](/sdk-documentation/sdk-references/orm.storage#datauploadpdf) for more details.

#### scenes

List of scene items to be registered. See [DataUploadScene](/sdk-documentation/sdk-references/orm.storage#datauploadscene) for more details.

#### skip\_duplicate\_urls

If set to `True`, Encord service will skip items with URLs that already exist in the same folder.
Otherwise, duplicate items will be created.

#### upsert\_metadata

If set to `True`, Encord service will update metadata of existing items with the same URL in the same folder.
This flag has no effect if `skip_duplicate_urls` is set to `False`.

## DatasetDataLongPollingParams Objects

```python theme={"dark"}
class DatasetDataLongPollingParams(BaseDTO)
```

Parameters for long-polling dataset data upload or import.

**Arguments**:

* `data_items` - Structured items to be uploaded as part of the job.
* `files` - Optional mapping of filenames to file contents (for file-based
  imports such as JSON manifests).
* `integration_id` - UUID of the integration used to access external storage.
* `ignore_errors` - If `True`, continue processing other items even if some
  fail.
* `folder_uuid` - UUID of the storage folder where data should be registered.
* `file_name` - Optional name of the manifest file associated with the job.

## PostUploadJobParams Objects

```python theme={"dark"}
class PostUploadJobParams(BaseDTO)
```

Parameters for starting an upload job.

**Arguments**:

* `data_items` - Structured items to be uploaded as part of the job.
* `external_files` - Mapping of filenames to file contents for file-based imports.
* `integration_hash` - UUID of the integration used to access external storage.
* `ignore_errors` - If `True`, continue processing other items even if some
  fail.
* `file_name` - Optional name of the manifest file associated with the job.

## GetUploadJobParams Objects

```python theme={"dark"}
class GetUploadJobParams(BaseDTO)
```

Parameters for polling the status of an upload job.

**Arguments**:

* `timeout_seconds` - Maximum number of seconds to wait before returning the
  current job status.

## FoldersSortBy Objects

```python theme={"dark"}
class FoldersSortBy(CamelStrEnum)
```

Sorting options for listing items or folders.

**Values:**

* **NAME:** Sort by name.
* **CREATED\_AT:** Sort by creation time.

## ListItemsParams Objects

```python theme={"dark"}
class ListItemsParams(BaseDTO)
```

Parameters for listing storage items in a folder.

**Arguments**:

* `search` - Optional free-text search string to filter items.
* `is_recursive` - If `True`, include items in nested subfolders.
* `is_in_dataset` - If set, filter items that are (or are not) linked to datasets.
* `item_types` - List of item types to include in the response.
* `include_org_access` - If `True`, include items accessible via organization-level
  access.
* `order` - Sort order for the results.
* `desc` - If `True`, sort in descending order.
* `page_token` - Token for fetching the next page of results.
* `page_size` - Maximum number of items to return.
* `sign_urls` - If `True`, include signed URLs for the items in the
  response.

## ListFoldersParams Objects

```python theme={"dark"}
class ListFoldersParams(BaseDTO)
```

Parameters for listing folders in Encord storage.

**Arguments**:

* `search` - Optional free-text search string to filter folders.
* `is_recursive` - If `True`, include nested subfolders in the listing.
* `dataset_synced` - If set, filter folders that are (or are not) synced with a
  dataset.
* `include_org_access` - If `True`, include folders accessible via organization-level
  access.
* `order` - Field to sort folders by.
* `desc` - If `True`, sort in descending order.
* `page_token` - Token for fetching the next page of results.
* `page_size` - Maximum number of folders to return (defaults to 100).

## PatchItemPayload Objects

```python theme={"dark"}
class PatchItemPayload(BaseDTO)
```

Payload for partially updating a storage item.

**Arguments**:

* `name` - New name for the item, if updating.
* `description` - New description for the item, if updating.
* `client_metadata` - New custom metadata to merge or overwrite, depending on API semantics.

## PatchFolderPayload Objects

```python theme={"dark"}
class PatchFolderPayload(BaseDTO)
```

Payload for partially updating a storage folder.

**Arguments**:

* `name` - New name for the folder, if updating.
* `description` - New description for the folder, if updating.
* `client_metadata` - New custom metadata to merge or overwrite, depending on API semantics.

## PatchFoldersBulkPayload Objects

```python theme={"dark"}
class PatchFoldersBulkPayload(BaseDTO)
```

Payload for applying partial updates to multiple folders.

**Arguments**:

* `folder_patches` - Mapping from folder UUID (as string) to patch payload to
  apply to that folder.

## StorageFolderSummary Objects

```python theme={"dark"}
class StorageFolderSummary(BaseDTO)
```

Summary statistics for a storage folder.

**Arguments**:

* `files` - Total number of files in the folder.
* `folders` - Total number of subfolders.
* `videos` - Number of video items.
* `images` - Number of image items.
* `image_groups` - Number of image group items.
* `image_sequences` - Number of image sequence items.
* `dicom_files` - Number of DICOM file items.
* `dicom_series` - Number of DICOM series items.
* `niftis` - Number of NIFTI items.
* `audios` - Number of audio items.
* `pdfs` - Number of PDF items.
* `plain_texts` - Number of plain text items.
* `tombstones` - Number of tombstone items.
* `upload_jobs` - Number of upload jobs associated with this folder.
* `total_size` - Approximate total size of all items in bytes.

## ItemShortInfo Objects

```python theme={"dark"}
class ItemShortInfo(BaseDTO)
```

Short information about a storage item, typically used in summaries.

**Arguments**:

* `uuid` - UUID of the item.
* `name` - Name of the item.
* `parent_uuid` - UUID of the parent folder.
* `parent_name` - Name of the parent folder.
* `item_type` - Type of the item.

## DatasetShortInfo Objects

```python theme={"dark"}
class DatasetShortInfo(BaseDTO)
```

Short information about a dataset that uses a storage item.

**Arguments**:

* `dataset_hash` - Identifier of the dataset.
* `backing_folder_uuid` - UUID of the backing folder for the dataset, if any.
* `title` - Title of the dataset.
* `data_hashes` - List of data unit identifiers linked to the dataset.
* `data_units_created_at` - Timestamp when the data units were created.

## StorageItemSummary Objects

```python theme={"dark"}
class StorageItemSummary(BaseDTO)
```

A summary of item usage in the system

#### frame\_in\_groups

A number of group items (DICOM\_SERIES, IMAGE\_GROUP, IMAGE\_SEQUENCE) that contain this item

#### accessible\_group\_items

List of group items that contain this item (only those that the user has access to,
so the length of this list can be less than `frame_in_groups`)

#### used\_in\_datasets

A number of datasets that contain this item as a `DataRow`

#### accessible\_datasets

List of datasets that contain this item as a `DataRow` (only those that the user has access to, so
the length of this list can be less than `used_in_datasets`)

#### data\_group

Data group layout information. Only populated when the item is a GROUP.

## DeleteItemsParams Objects

```python theme={"dark"}
class DeleteItemsParams(BaseDTO)
```

Parameters controlling how storage items are deleted.

**Arguments**:

* `remove_unused_frames` - If `True`, also remove frames that are no longer used by
  any group items after deletion.

## DeleteItemsPayload Objects

```python theme={"dark"}
class DeleteItemsPayload(BaseDTO)
```

Payload for deleting storage items.

**Arguments**:

* `child_uuids` - UUIDs of the child items to delete.
* `remove_unused_frames` - If `True`, also remove frames that are no longer referenced
  after deletion.

## DeleteItemsResponse Objects

```python theme={"dark"}
class DeleteItemsResponse(BaseDTO)
```

Response returned after deleting storage items.

**Arguments**:

* `removed_items_count` - Number of storage items removed.
* `removed_folders_count` - Number of folders removed.

## MoveItemsPayload Objects

```python theme={"dark"}
class MoveItemsPayload(BaseDTO)
```

Payload for moving storage items to a new folder.

**Arguments**:

* `item_uuids` - UUIDs of the items to move.
* `new_parent_uuid` - UUID of the destination folder.
* `allow_synced_dataset_move` - If `True`, allow moving items that are linked to synced
  datasets.

## MoveFoldersPayload Objects

```python theme={"dark"}
class MoveFoldersPayload(BaseDTO)
```

Payload for moving folders to a new parent folder.

**Arguments**:

* `folder_uuids` - UUIDs of the folders to move.
* `new_parent_uuid` - UUID of the destination folder, or `None` to move to root.

## GetItemParams Objects

```python theme={"dark"}
class GetItemParams(BaseDTO)
```

Parameters for fetching detailed information about a storage item.

**Arguments**:

* `sign_url` - If `True`, include a signed URL for temporary access to the
  item in the response.

## GetChildItemsParams Objects

```python theme={"dark"}
class GetChildItemsParams(BaseDTO)
```

Parameters for listing direct children of a storage folder.

**Arguments**:

* `sign_urls` - If `True`, include signed URLs for the items in the
  response.

## GetItemsBulkPayload Objects

```python theme={"dark"}
class GetItemsBulkPayload(BaseDTO)
```

Payload for fetching multiple storage items at once.

**Arguments**:

* `item_uuids` - UUIDs of the items to fetch.
* `sign_urls` - If `True`, include signed URLs for the items in the
  response.

## PatchItemsBulkPayload Objects

```python theme={"dark"}
class PatchItemsBulkPayload(BaseDTO)
```

Payload for applying partial updates to multiple storage items.

**Arguments**:

* `item_patches` - Mapping from item UUID (as string) to patch payload to apply
  to that item.

## BundledPatchItemPayload Objects

```python theme={"dark"}
@dataclass
class BundledPatchItemPayload()
```

Accumulator for batched item patch operations.

**Arguments**:

* `item_patches` - Mapping from item UUID (as string) to patch payload to apply
  to that item.

## BundledPatchFolderPayload Objects

```python theme={"dark"}
@dataclass
class BundledPatchFolderPayload()
```

Accumulator for batched folder patch operations.

**Arguments**:

* `folder_patches` - Mapping from folder UUID (as string) to patch payload to
  apply to that folder.

## ReencodeVideoItemsRequest Objects

```python theme={"dark"}
class ReencodeVideoItemsRequest(BaseDTO)
```

Request to re-encode a set of video storage items.

**Arguments**:

* `storage_items` - UUIDs of the storage items (videos) to re-encode.
* `process_title` - Human-readable title for the re-encode job.
* `force_full_reencoding` - If `True`, force re-encoding even if a compatible version
  already exists.

## JobStatus Objects

```python theme={"dark"}
class JobStatus(CamelStrEnum)
```

Status of a background job.

**Values**:

* **SUBMITTED:** Job has been submitted and is waiting to start.
* **DONE:** Job has completed successfully.
* **ERROR:** Job has failed.

## ReencodeVideoItemsResponse Objects

```python theme={"dark"}
class ReencodeVideoItemsResponse(BaseDTO)
```

Response returned after starting or querying a re-encode job.

**Arguments**:

* `status` - Current status of the re-encode job.
* `result` - Optional result payload, for example a list or dict
  with additional information about the re-encoded items.

## StorageItemsMigratePayload Objects

```python theme={"dark"}
class StorageItemsMigratePayload(BaseDTO)
```

Payload for migrating storage items between integrations.

**Arguments**:

* `urls_map` - Optional mapping from source URLs to target URLs. If the value
  is `None`, the item for that URL will be skipped.
* `items_map` - Optional mapping from item UUIDs to new URLs. If the value
  is `None`, the item will be skipped.
* `from_integration_hash` - UUID of the source integration to migrate from.
* `to_integration_hash` - UUID of the target integration to migrate to.
* `validate_access` - If `True`, validate that the SDK has access to the target
  integration before migrating.
* `skip_missing` - If `True`, skip items that cannot be found instead of
  failing the entire migration.

## AddDataToFolderJobCancelResponse Objects

```python theme={"dark"}
class AddDataToFolderJobCancelResponse(BaseDTO)
```

Response returned after canceling an add-data-to-folder job.

Arg:
units\_cancelled\_count: Number of individual job units that were canceled.

## SyncPrivateDataWithCloudSyncedFolderGetResultParams Objects

```python theme={"dark"}
class SyncPrivateDataWithCloudSyncedFolderGetResultParams(BaseDTO)
```

Parameters for polling the status of a cloud-synced folder sync job.

**Arguments**:

* `timeout_seconds` - Maximum number of seconds to wait before returning the
  current synchronization status.

## SyncPrivateDataWithCloudSyncedFolderStatus Objects

```python theme={"dark"}
class SyncPrivateDataWithCloudSyncedFolderStatus(CamelStrEnum)
```

Enumeration representing the possible states of a cloud-synced folder synchronization job.

This enum is used to track the life cycle of a synchronization operation between
an Encord storage folder and its linked cloud storage bucket.

#### PENDING

The synchronization job is currently in progress.

This status indicates that either:

* The job is queued and waiting to be processed
* The job is actively processing bucket content
* The job is creating or updating items in the Encord storage folder

#### DONE

The synchronization job has successfully completed.

This status indicates that all phases of the synchronization (bucket scanning,
item creation/updating/tombstoning) have been completed without critical errors.
Note that individual items may still have failed to process (check upload\_jobs\_units\_error).

#### ERROR

The synchronization job encountered a critical error.

This status indicates that a severe error occurred during synchronization,
such as:

* Unable to access the cloud storage bucket
* Database transaction failures
* Other system-level errors

When in ERROR state, the sync operation is considered failed and should be restarted.

#### CANCELLED

The synchronization job was manually canceled.

This status indicates that the job was explicitly terminated before completion.

## SyncPrivateDataWithCloudSyncedFolderGetResultResponse Objects

```python theme={"dark"}
class SyncPrivateDataWithCloudSyncedFolderGetResultResponse(BaseDTO)
```

Response object representing the status and results of a cloud-synced folder synchronization job.

This class provides comprehensive details about each stage of the synchronization process,
including bucket scanning, upload job creation, and processing of individual files.

#### status

Overall status of the synchronization job

#### scan\_pages\_processing\_pending

Number of bucket listing pages waiting to be processed

#### scan\_pages\_processing\_done

Number of bucket listing pages successfully processed

#### scan\_pages\_processing\_error

Number of bucket listing pages that failed during processing

#### scan\_pages\_processing\_cancelled

Number of bucket listing pages that were canceled during processing

#### upload\_jobs\_pending

Number of upload jobs waiting to be processed

#### upload\_jobs\_done

Number of upload jobs successfully completed

#### upload\_jobs\_error

Number of upload jobs that failed during processing

#### upload\_jobs\_units\_pending

Number of individual files waiting to be processed

#### upload\_jobs\_units\_done

Number of individual files successfully synchronized

#### upload\_jobs\_units\_error

Number of individual files that failed to synchronize

#### upload\_jobs\_units\_cancelled

Number of individual files that were canceled during synchronization