Skip to main content
PATCH
/
Dataset
/
{datasetId}
Update a dataset
curl --request PATCH \
  --url https://api.starleads.co/Dataset/{datasetId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "Updated Name",
  "parserConfig": {
    "chunkTokenNum": 512
  }
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "chunkMethod": "<string>",
  "parserConfig": {
    "chunkTokenNum": 123,
    "layoutRecognize": true,
    "delimiter": "<string>",
    "taskPageSize": 123
  },
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-Api-Key
string
header
required

Headers

X-Api-Key
string
required

Api key to pass as a X-Api-Key request header.

Path Parameters

datasetId
string
required

ID of the dataset.

Body

application/json

Partial update for a dataset. Only provided fields will be updated

name
string | null

Dataset name (if provided: 1-255 chars)

description
string | null

Dataset description

chunkMethod
string | null

Chunking method identifier

parserConfig
object

Configuration options for dataset document parsing

Response

Dataset updated successfully

Public representation of a dataset

id
string

Dataset identifier

name
string

Dataset name

description
string | null

Dataset description

chunkMethod
string | null

Chunking method identifier

parserConfig
object

Configuration options for dataset document parsing

createdAt
string<date-time>

Creation timestamp