Skip to content

Create Dataset API

API Information

  • Request Path: /dataset/create
  • Request Method: POST
  • Content-Type: multipart/form-data

Request Headers

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token
Content-TypeStringYesMust be set to multipart/form-data

Request Body Structure

FieldTypeRequiredDescriptionConstraints
datasetNameStringYesDataset nameCannot be empty, maximum 50 characters
descriptionStringNoDataset descriptionMaximum 1024 characters
pictureFileNoDataset cover imageImage file
providerStringNoDataset sourceAny string
tagIdsList<Long>YesTag ID listArray of tag IDs

Parameter Example

json
{
  "datasetName": "My Dataset",
  "description": "This is a test dataset",
  "provider": "User Upload",
  "tagIds": [1, 2, 3]
}

Response Body Structure

CommonResponse Object

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataDataSetCreateRespDataset create information

DataSetCreateResp Object

FieldTypeDescription
datasetIdLongDataset ID

Response Examples

Success Response

json
{
  "code": 200,
  "message": "success",
  "data": {
    "datasetId": 8
  }
}

Failure Response

json
{
  "code": 400,
  "message": "Dataset name is required",
  "data": null
}

Error Code Description

Error CodeDescription
200Success
400Request parameter error
401Unauthorized
500Server internal error

Usage Instructions

  1. This API is used to create new datasets
  2. Dataset name is required and cannot exceed 50 characters
  3. Dataset description is optional but cannot exceed 1024 characters
  4. Dataset cover image can be uploaded (optional)
  5. At least one tag ID must be specified
  6. User authentication is required, valid Authorization token must be included in request headers

Notes

  • Dataset name cannot be empty
  • Dataset name length cannot exceed 50 characters
  • Dataset description length cannot exceed 1024 characters
  • Tag ID list cannot be empty
  • Image file size and format limitations refer to system configuration