Edit a dataset

Request

Update a dataset's metadata.

Security

ApiKey(Required scopes: datasets.update)

Path

idstringrequired

Dataset ID

Bodyapplication/jsonrequired

non-empty

namestring, [ 1 .. 100 ] characters

Updated display name. Must be unique within the project (case-insensitive) among datasets.

descriptionstring or null, [ 1 .. 500 ] characters

Updated display description. Pass null to clear an existing description.

Payload

{
  "name": "string",
  "description": "string"
}

Responses

The updated dataset

Bodyapplication/json

idstringrequired

ID of the dataset.

projectIdstringrequired

ID of the project the dataset belongs to.

namestringrequired

Display name.

descriptionstring or null

Optional display description.

creatorOrgMemberIdstring or null

ID of the org member who created the dataset. Null when the dataset was created via API-key auth (in which case creatorApiKeyId is set).

creatorApiKeyIdstring or null

ID of the API key that created the dataset. Null when the dataset was created via session auth (in which case creatorOrgMemberId is set).

createdAtstring, (date-time)required

Timestamp when the dataset was created.

updatedAtstring, (date-time)required

Timestamp when the dataset was last updated.

episodeCountinteger, >= 0

Number of episodes in this dataset.

Response

{
  "id": "string",
  "projectId": "string",
  "name": "string",
  "description": "string",
  "creatorOrgMemberId": "string",
  "creatorApiKeyId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "episodeCount": 0
}