---
title: "Get Dataset By Id"
method: GET
path: "/api/v1/datasets/{dataset_id}"
tags: ["datasets > dataset"]
---

# Get Dataset By Id

`GET /api/v1/datasets/{dataset_id}`

Get a dataset by its unique identifier

## Path parameters

- `dataset_id` string, uuid, required

## Query parameters

- `include_deleted` boolean

## Headers

- `Authorization` string, required

## Response `200`

Successful Response

- DatasetsDatasetResponse
  - `created_dt` string, date-time, required — The created datetime of the resource in ISO 8601 format.
  - `updated_dt` string, date-time, nullable — The datetime the resource was last updated in ISO 8601 format.
  - `created_by` string, required — ID of the user who added the asset to the dataset.
  - `updated_by` string, nullable — ID of the user who last updated the asset.
  - `deleted_dt` string, date-time, nullable — Timestamp if the resource was deleted.
  - `deleted_by` string, nullable — ID of the user who deleted the resource.
  - `id` string, uuid, required — The unique identifier for the dataset.
  - `name` string, required — Name of the dataset, must be unique per organization and must only contain alphanumeric and underscore characters.
  - `embeddings` DatasetsEncoder[], required — The encoders of the dataset.
    - `id` string, uuid, required — The unique identifier for the encoder.
    - `name` union, required — The model used to extract visual and audio features from assets.
      - 'multimodal' | 'multimodal-tx-large2' | 'multimodal-tx-large3' | 'multimodal-tx-large4' | 'nova2-multimodal' | 'resnet-50' | 'resnet-50-reduced'
      - string
    - `modality` string, required — The supported modality of the encoder.
    - `modalities` string[], required — The supported modalities of the encoder.
  - `encoders` DatasetsEncoder[], required — The encoders of the dataset.
    - `id` string, uuid, required — The unique identifier for the encoder.
    - `name` union, required — The model used to extract visual and audio features from assets.
      - 'multimodal' | 'multimodal-tx-large2' | 'multimodal-tx-large3' | 'multimodal-tx-large4' | 'nova2-multimodal' | 'resnet-50' | 'resnet-50-reduced'
      - string
    - `modality` string, required — The supported modality of the encoder.
    - `modalities` string[], required — The supported modalities of the encoder.
  - `description` string, nullable, required — A short summary of what the dataset includes or is intended for.
  - `allowed_asset_types` DatasetsAssetTypeEnum[], required — Types of assets allowed in this dataset.
  - `status` 'active' | 'inactive' | 'deleting' | 'deleted', required — Indicates the operational status of a dataset
  - `keyframe_sampling_method` 'intelligent' | 'uniform', required — Indicates the method used to sample keyframes from a video
  - `keyframe_uniform_fps_sampling_rate` number, double, nullable — FPS rate used for uniform sampling.
  - `store_original` boolean, required — Whether the original file is stored.
  - `store_preview` boolean, required — Whether preview files are stored.
  - `metadata_fields_to_index` string[], nullable — The metadata fields to index for the dataset.
  - `metadata_fields_to_embed` string[], nullable — The metadata fields to embed for the dataset.
  - `dataset_config` DatasetsDatasetConfig
    - `embedding_id` object, required — Mapping from encoder modality to the UUID of the embedding model used for that modality.
    - `encoder_name` object, required — Mapping from encoder modality to the name of the encoder model used for that modality.
    - `extra_config` DatasetsExtraConfig
      - `composite_settings` object, required — Mapping of composite type name to its settings.
    - `hybrid_search` DatasetsHybridSearchConfig
      - `weights` object, required — Weights for each modality used in hybrid search scoring.
    - `context_studio_enabled` boolean, nullable — Whether Context Studio is enabled for this dataset.
    - `metadata_fields_to_embed` string[], nullable — Metadata fields whose values are embedded.
    - `metadata_fields_to_index` string[], nullable — Metadata fields that are indexed for filtering and search.
    - `celebrity_detection_enabled` boolean, nullable — Whether celebrity detection is enabled for this dataset.
    - `agentic_search_metadata_description` object, nullable — Per-key descriptions of metadata fields.
    - `asset_identifier_key` string, nullable — The metadata field name that uniquely identifies each asset in the dataset.
    - `context_studio_export_json_connection_name` string, nullable — The name of the connection required for external s3 export. (this is related to context_studio feature).

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/coactive/apis/api-reference.md) · [All operations](https://skmtc.dev/coactive/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/coactive/api-reference/revisions/1223758be9ba/schema)