Skip to main content
Cohere

Search documentation

Type to search this documentation.

Get a Dataset

GET/v1/datasets/{id}Get a Dataset

Retrieve a dataset by ID. See 'Datasets' for more information.

Parameters

idstringpathrequired

pattern ^(?!usage$).*$

X-Client-Namestringheader

The name of the project that is making the request.

Responses

200A successful response.application/json
object
datasetobjectrequired
Show child attributes
created_atstring · date-timerequired

The creation date

dataset_partsarray of object

the underlying files that make up the dataset

Show child attributes
Show array items
idstringrequired

The dataset part ID

indexinteger · int32

The index of the file

namestringrequired

The name of the dataset part

num_rowsinteger · int32

The number of rows in the file

original_urlstring

The download url of the original file

samplesarray of string

The first few rows of the parsed file

Show child attributes
size_bytesinteger · int32

The size of the file in bytes

urlstring

The download url of the file

dataset_typestringrequired

The type of the dataset

one of "embed-input", "embed-result", "cluster-result", "cluster-outliers", "reranker-finetune-input", "single-label-classification-finetune-input", "chat-finetune-input", "multi-label-classification-finetune-input", "batch-chat-input", "batch-openai-chat-input", "batch-embed-v2-input", "batch-chat-v2-input"

idstringrequired

The dataset ID

metricsobject
Show child attributes
finetune_dataset_metricsobject
Show child attributes
chat_data_metricsobject
Show child attributes
num_eval_turnsnumber · int64

The sum of all turns of valid eval examples.

num_train_turnsnumber · int64

The sum of all turns of valid train examples.

preamblestring

The preamble of this dataset.

classify_data_metricsobject
Show child attributes
label_metricsarray of object
Show child attributes
Show array items
labelstring

value of the label

samplesarray of string

samples for this label

Show child attributes
total_examplesnumber · int64

Total number of examples for this label

eval_examplesnumber · int64

Number of evaluation examples.

eval_size_bytesnumber · int64

The size in bytes of all eval examples.

reranker_data_metricsobject
Show child attributes
num_eval_hard_negativesnumber · int64

The sum of all hard negatives of valid eval examples.

num_eval_queriesnumber · int64

The number of evaluation queries.

num_eval_relevant_passagesnumber · int64

The sum of all relevant passages of valid eval examples.

num_train_hard_negativesnumber · int64

The sum of all hard negatives of valid training examples.

num_train_queriesnumber · int64

The number of training queries.

num_train_relevant_passagesnumber · int64

The sum of all relevant passages of valid training examples.

total_examplesnumber · int64

The overall number of examples.

train_examplesnumber · int64

The number of training examples.

train_size_bytesnumber · int64

The size in bytes of all training examples.

trainable_token_countnumber · int64

The number of tokens of valid examples that can be used for training.

namestringrequired

The name of the dataset

parse_infoobject
Show child attributes
delimiterstring
separatorstring
preserve_fieldsarray of string
Show child attributes
required_fieldsarray of string
Show child attributes
schemastring

the avro schema of the dataset

updated_atstring · date-timerequired

The last update date

validation_errorstring

Errors found during validation

validation_statusstringrequired

The validation status of the dataset

one of "unknown", "queued", "processing", "failed", "validated", "skipped"

validation_warningsarray of string

warnings found during validation

Show child attributes
Example response
{
  "dataset": {
    "created_at": "2026-06-09T00:00:00Z",
    "dataset_parts": [
      {
        "id": "string",
        "index": 0,
        "name": "string",
        "num_rows": 0,
        "original_url": "string",
        "samples": [
          "string"
        ],
        "size_bytes": 0,
        "url": "string"
      }
    ],
    "dataset_type": "batch-chat-input",
    "id": "string",
    "metrics": {
      "finetune_dataset_metrics": {
        "chat_data_metrics": {
          "num_eval_turns": 0,
          "num_train_turns": 0,
          "preamble": "string"
        },
        "classify_data_metrics": {
          "label_metrics": [
            {
              "label": "string",
              "samples": [
                "string"
              ],
              "total_examples": 0
            }
          ]
        },
        "eval_examples": 0,
        "eval_size_bytes": 0,
        "reranker_data_metrics": {
          "num_eval_hard_negatives": 0,
          "num_eval_queries": 0,
          "num_eval_relevant_passages": 0,
          "num_train_hard_negatives": 0,
          "num_train_queries": 0,
          "num_train_relevant_passages": 0
        },
        "total_examples": 0,
        "train_examples": 0,
        "train_size_bytes": 0,
        "trainable_token_count": 0
      }
    },
    "name": "string",
    "parse_info": {},
    "preserve_fields": [
      "string"
    ],
    "required_fields": [
      "string"
    ],
    "schema": "string",
    "updated_at": "2026-06-09T00:00:00Z",
    "validation_error": "string",
    "validation_status": "failed",
    "validation_warnings": [
      "string"
    ]
  }
}
400This error is returned when the request is not well formed. This could be because: - JSON is invalid - The request is missing required fields - The request contains an invalid combination of fields application/json
object
idstring
messagestring
Example response
{
  "id": "string",
  "message": "string"
}
401This error indicates that the operation attempted to be performed is not allowed. This could be because: - The api token is invalid - The user does not have the necessary permissions application/json
object
idstring
messagestring
Example response
{
  "id": "string",
  "message": "string"
}
403This error indicates that the operation attempted to be performed is not allowed. This could be because: - The api token is invalid - The user does not have the necessary permissions application/json
object
idstring
messagestring
Example response
{
  "id": "string",
  "message": "string"
}
404This error is returned when a resource is not found. This could be because: - The endpoint does not exist - The resource does not exist eg model id, dataset id application/json
object
idstring
messagestring
Example response
{
  "id": "string",
  "message": "string"
}
422This error is returned when the request is not well formed. This could be because: - JSON is invalid - The request is missing required fields - The request contains an invalid combination of fields application/json
object
idstring
messagestring
Example response
{
  "id": "string",
  "message": "string"
}
429Too many requestsapplication/json
object
idstring
messagestring
Example response
{
  "id": "string",
  "message": "string"
}
498This error is returned when a request or response contains a deny-listed token. application/json
object
idstring
messagestring
Example response
{
  "id": "string",
  "message": "string"
}
499This error is returned when a request is cancelled by the user. application/json
object
idstring
messagestring
Example response
{
  "id": "string",
  "message": "string"
}
500This error is returned when an uncategorised internal server error occurs. application/json
object
idstring
messagestring
Example response
{
  "id": "string",
  "message": "string"
}
501This error is returned when the requested feature is not implemented. application/json
object
idstring
messagestring
Example response
{
  "id": "string",
  "message": "string"
}
503This error is returned when the service is unavailable. This could be due to: - Too many users trying to access the service at the same time application/json
object
idstring
messagestring
Example response
{
  "id": "string",
  "message": "string"
}
504This error is returned when a request to the server times out. This could be due to: - An internal services taking too long to respond application/json
object
idstring
messagestring
Example response
{
  "id": "string",
  "message": "string"
}
Documentation menu