Dataset

Generated on 18 Mar 2026

Base URL https://api.paperspace.com/v1

GET List datasets

/datasets
Authorizations: BearerAuth
Http: Bearer

An API key or access token

List datasets

Query Parameters

after string optional

Fetch the next page of results after this cursor.

limit integer 1 – 120 optional

The number of items to fetch after this page.

orderBy string, one of: dtCreated optional

Order results by one of these fields.

Default: dtCreated
order string, one of: asc, desc optional

The order to sort the results by.

Default: desc
teamId string optional
privacy anyOf optional
Default: PRIVATE
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/datasets"

Responses

200

Successful response

hasMore boolean required

Whether there are more pages of results available.

items array of object required

The items on this page.

Show child properties
description string required Nullable

The description of the dataset

dtCreated string (date-time) required

The date the dataset was created

dtModified string (date-time) required

The date the dataset was last modified

id string required

The ID of the dataset

isPublic boolean required

Whether the dataset is public

name string required Nullable

The name of the dataset

storageProviderId string required Nullable

The ID of the storage provider

teamId string required

The ID of the team that owns the dataset

nextPage string optional

The cursor required to fetch the next page of results. i.e. ?after=nextPage. This is null when there is no next page.

default

Error response

code string required
details object optional
message string required
{
  "hasMore": true,
  "items": [
    {
      "description": "string",
      "dtCreated": "2019-08-24T14:15:22Z",
      "dtModified": "2019-08-24T14:15:22Z",
      "id": "string",
      "isPublic": true,
      "name": "string",
      "storageProviderId": "string",
      "teamId": "string"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

POST Create a dataset

/datasets
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Create a dataset

Request Body: application/json

description string optional Nullable

The description of the dataset

isPublic boolean required

Whether the dataset is public

name string required

The name of the dataset

storageProviderId string optional

The ID of the storage provider

Content type application/json
{
  "isPublic": true,
  "name": "string",
  "storageProviderId": "string"
}
curl -X POST \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "isPublic": true,
  "name": "string",
  "storageProviderId": "string"
}' \
  "https://api.paperspace.com/v1/datasets"

Responses

200

Successful response

description string required Nullable

The description of the dataset

dtCreated string (date-time) required

The date the dataset was created

dtModified string (date-time) required

The date the dataset was last modified

id string required

The ID of the dataset

isPublic boolean required

Whether the dataset is public

name string required Nullable

The name of the dataset

storageProviderId string required Nullable

The ID of the storage provider

teamId string required

The ID of the team that owns the dataset

default

Error response

code string required
details object optional
message string required
{
  "description": "string",
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtModified": "2019-08-24T14:15:22Z",
  "id": "string",
  "isPublic": true,
  "name": "string",
  "storageProviderId": "string",
  "teamId": "string"
}
{
  "code": "string",
  "message": "string"
}

GET List dataset versions

/datasets/{datasetId}/versions
Authorizations: BearerAuth
Http: Bearer

An API key or access token

List dataset versions

Path Parameters

datasetId string required

The ID of the dataset

Query Parameters

after string optional

Fetch the next page of results after this cursor.

limit integer 1 – 120 optional

The number of items to fetch after this page.

orderBy string, one of: dtCreated optional

Order results by one of these fields.

Default: dtCreated
order string, one of: asc, desc optional

The order to sort the results by.

Default: desc
tags string optional
curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/datasets/{datasetId}/versions"

Responses

200

Successful response

hasMore boolean required

Whether there are more pages of results available.

items array of object required

The items on this page.

Show child properties
datasetId string required

The ID of the dataset

dtCreated string (date-time) required

The date the version was created

dtModified string (date-time) required

The date the version was last modified

isCommitted boolean required

Whether the version is committed

message string required Nullable

The description of the dataset version

metadata object required Nullable

Metadata for the version.

Show child properties
(additional properties) object optional

Additional properties are allowed.

tags array of string required

The tags for the version

url string required Nullable

The URL of the version

usageBytes string required Nullable

The size of the dataset at this version in bytes

userId string required Nullable

The ID of the user that created the version

version string required

The version of the dataset

nextPage string optional

The cursor required to fetch the next page of results. i.e. ?after=nextPage. This is null when there is no next page.

default

Error response

code string required
details object optional
message string required
{
  "hasMore": true,
  "items": [
    {
      "datasetId": "string",
      "dtCreated": "2019-08-24T14:15:22Z",
      "dtModified": "2019-08-24T14:15:22Z",
      "isCommitted": true,
      "message": "string",
      "tags": [],
      "url": "string",
      "usageBytes": "string",
      "userId": "string",
      "version": "string"
    }
  ],
  "nextPage": "string"
}
{
  "code": "string",
  "message": "string"
}

POST Create a dataset version

/datasets/{datasetId}/versions
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Create a dataset version

Path Parameters

datasetId string required

The ID of the dataset

Request Body: application/json

message string optional

The description of the dataset version

metadata object optional

Metadata for the version.

Show child properties
(additional properties) object optional

Additional properties are allowed.

tags string optional

The tags for the version, comma-delimited

Content type application/json
{
  "message": "string",
  "tags": "string"
}
curl -X POST \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "string",
  "tags": "string"
}' \
  "https://api.paperspace.com/v1/datasets/{datasetId}/versions"

Responses

200

Successful response

datasetId string required

The ID of the dataset

dtCreated string (date-time) required

The date the version was created

dtModified string (date-time) required

The date the version was last modified

isCommitted boolean required

Whether the version is committed

message string required Nullable

The description of the dataset version

metadata object required Nullable

Metadata for the version.

Show child properties
(additional properties) object optional

Additional properties are allowed.

tags array of string required

The tags for the version

url string required Nullable

The URL of the version

usageBytes string required Nullable

The size of the dataset at this version in bytes

userId string required Nullable

The ID of the user that created the version

version string required

The version of the dataset

default

Error response

code string required
details object optional
message string required
{
  "datasetId": "string",
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtModified": "2019-08-24T14:15:22Z",
  "isCommitted": true,
  "message": "string",
  "tags": [
    "string"
  ],
  "url": "string",
  "usageBytes": "string",
  "userId": "string",
  "version": "string"
}
{
  "code": "string",
  "message": "string"
}

GET Get a dataset version

/datasets/{datasetId}/versions/{version}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Get a dataset version

Path Parameters

datasetId string required

The ID of the dataset

version string required

The version of the dataset

curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/datasets/{datasetId}/versions/{version}"

Responses

200

Successful response

datasetId string required

The ID of the dataset

dtCreated string (date-time) required

The date the version was created

dtModified string (date-time) required

The date the version was last modified

isCommitted boolean required

Whether the version is committed

message string required Nullable

The description of the dataset version

metadata object required Nullable

Metadata for the version.

Show child properties
(additional properties) object optional

Additional properties are allowed.

tags array of string required

The tags for the version

url string required Nullable

The URL of the version

usageBytes string required Nullable

The size of the dataset at this version in bytes

userId string required Nullable

The ID of the user that created the version

version string required

The version of the dataset

default

Error response

code string required
details object optional
message string required
{
  "datasetId": "string",
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtModified": "2019-08-24T14:15:22Z",
  "isCommitted": true,
  "message": "string",
  "tags": [
    "string"
  ],
  "url": "string",
  "usageBytes": "string",
  "userId": "string",
  "version": "string"
}
{
  "code": "string",
  "message": "string"
}

PUT Update a dataset version

/datasets/{datasetId}/versions/{version}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Update a dataset version

Path Parameters

datasetId string required

The ID of the dataset

version string required

The version of the dataset

Request Body: application/json

isCommitted boolean optional

Whether the version is committed

message string optional

The description of the dataset version

metadata object optional

Metadata for the version.

Show child properties
(additional properties) object optional

Additional properties are allowed.

tags string optional

The tags for the version, comma-delimited

Content type application/json
{
  "isCommitted": true,
  "message": "string",
  "tags": "string"
}
curl -X PUT \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "isCommitted": true,
  "message": "string",
  "tags": "string"
}' \
  "https://api.paperspace.com/v1/datasets/{datasetId}/versions/{version}"

Responses

200

Successful response

datasetId string required

The ID of the dataset

dtCreated string (date-time) required

The date the version was created

dtModified string (date-time) required

The date the version was last modified

isCommitted boolean required

Whether the version is committed

message string required Nullable

The description of the dataset version

metadata object required Nullable

Metadata for the version.

Show child properties
(additional properties) object optional

Additional properties are allowed.

tags array of string required

The tags for the version

url string required Nullable

The URL of the version

usageBytes string required Nullable

The size of the dataset at this version in bytes

userId string required Nullable

The ID of the user that created the version

version string required

The version of the dataset

default

Error response

code string required
details object optional
message string required
{
  "datasetId": "string",
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtModified": "2019-08-24T14:15:22Z",
  "isCommitted": true,
  "message": "string",
  "tags": [
    "string"
  ],
  "url": "string",
  "usageBytes": "string",
  "userId": "string",
  "version": "string"
}
{
  "code": "string",
  "message": "string"
}

DELETE Delete a dataset version

/datasets/{datasetId}/versions/{version}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Delete a dataset version

Path Parameters

datasetId string required

The ID of the dataset

version string required

The version of the dataset

curl -X DELETE \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/datasets/{datasetId}/versions/{version}"

Responses

200

Successful response

datasetId string required

The ID of the dataset

version string required

The version of the dataset

default

Error response

code string required
details object optional
message string required
{
  "datasetId": "string",
  "version": "string"
}
{
  "code": "string",
  "message": "string"
}

GET Get a dataset

/datasets/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Get a dataset

Path Parameters

id string required

The ID of the dataset

curl -X GET \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/datasets/{id}"

Responses

200

Successful response

description string required Nullable

The description of the dataset

dtCreated string (date-time) required

The date the dataset was created

dtModified string (date-time) required

The date the dataset was last modified

id string required

The ID of the dataset

isPublic boolean required

Whether the dataset is public

name string required Nullable

The name of the dataset

storageProviderId string required Nullable

The ID of the storage provider

teamId string required

The ID of the team that owns the dataset

default

Error response

code string required
details object optional
message string required
{
  "description": "string",
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtModified": "2019-08-24T14:15:22Z",
  "id": "string",
  "isPublic": true,
  "name": "string",
  "storageProviderId": "string",
  "teamId": "string"
}
{
  "code": "string",
  "message": "string"
}

PUT Update a dataset

/datasets/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Update a dataset

Path Parameters

id string required

The ID of the dataset

Request Body: application/json

description string optional Nullable

The description of the dataset

name string optional

The name of the dataset

Content type application/json
{
  "name": "string"
}
curl -X PUT \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}' \
  "https://api.paperspace.com/v1/datasets/{id}"

Responses

200

Successful response

description string required Nullable

The description of the dataset

dtCreated string (date-time) required

The date the dataset was created

dtModified string (date-time) required

The date the dataset was last modified

id string required

The ID of the dataset

isPublic boolean required

Whether the dataset is public

name string required Nullable

The name of the dataset

storageProviderId string required Nullable

The ID of the storage provider

teamId string required

The ID of the team that owns the dataset

default

Error response

code string required
details object optional
message string required
{
  "description": "string",
  "dtCreated": "2019-08-24T14:15:22Z",
  "dtModified": "2019-08-24T14:15:22Z",
  "id": "string",
  "isPublic": true,
  "name": "string",
  "storageProviderId": "string",
  "teamId": "string"
}
{
  "code": "string",
  "message": "string"
}

DELETE Delete a dataset

/datasets/{id}
Authorizations: BearerAuth
Http: Bearer

An API key or access token

Delete a dataset

Path Parameters

id string required

The ID of the dataset

curl -X DELETE \
  -H "Authorization: Bearer $API_TOKEN" \
  "https://api.paperspace.com/v1/datasets/{id}"

Responses

200

Successful response

id string required

The ID of the dataset

default

Error response

code string required
details object optional
message string required
{
  "id": "string"
}
{
  "code": "string",
  "message": "string"
}

We can't find any results for your search.

Try using different keywords or simplifying your search terms.