Skip to main content
PUT
/
api
/
v1
/
datasets
/
{id}
Update a dataset
curl --request PUT \
  --url https://app.dimred.com/api/v1/datasets/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "dataset_name": "<string>",
  "dataset_source": "<string>"
}'
{
  "id": "<string>",
  "project_id": "<string>",
  "dataset_name": "<string>",
  "dataset_source": "<string>",
  "dataset_source_id": "<string>",
  "is_pinned": true,
  "datapoint_count": 123,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Obtain from your DimRed dashboard. The organization context is automatically derived from the API key.

Path Parameters

id
string
required

Dataset identifier

Body

application/json
dataset_name
string

Name of the dataset

dataset_source
string

Source of the dataset

Response

Dataset updated successfully

id
string

Unique identifier for the dataset

project_id
string

Project identifier

dataset_name
string

Name of the dataset

dataset_source
string

Source of the dataset

dataset_source_id
string | null

External source identifier

is_pinned
boolean

Whether the dataset is pinned

datapoint_count
integer

Number of datapoints in the dataset

created_at
string<date-time>

ISO 8601 timestamp of creation