Get Dataset

GET 
/v2/projects/datasets/:datasetid/

Retrieve a dataset by its ID.

This endpoint allows you to retrieve a dataset by providing its ID.

Parameters:

• datasetid (str): The ID of the dataset to retrieve.

Returns:

• Dataset: The retrieved dataset.

Raises:

• HTTPException: If the dataset is not found or the user is not authorized.

Request

Path Parameters

datasetid Datasetidrequired

Responses

200

Successful Response

application/json

Schema

Schema

id Id (string)required
name Name (string)required
size Size (integer)required
manifest objectrequired

status

object

anyOf

Status

string

Possible values: [PENDING, RUNNING, COMPLETED, FAILED]

data object[]required

Example (from schema)

{
  "id": "string",
  "name": "string",
  "size": 0,
  "manifest": {},
  "status": "PENDING",
  "data": [
    {}
  ]
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...