---
title: "Pull Dataset From Hub"
method: POST
path: "/felix/datasets/pull-from-hub"
tags: ["felix", "datasets"]
---

# Pull Dataset From Hub

`POST /felix/datasets/pull-from-hub`

Pull a dataset from HuggingFace Hub and save it locally.

Requires a HuggingFace API token with read access.
Optionally accepts session_id for SSE log streaming.

## Request body

- HuggingFacePullRequest — Request to pull dataset from HuggingFace Hub.
  - `repo_id` string, required — HuggingFace repo ID to pull from
  - `revision` string, nullable — Specific revision/branch to pull
  - `name` string, nullable — Name for the local dataset (defaults to repo name)
  - `hf_token` string, required — HuggingFace API token
  - `session_id` string, nullable — Session ID for SSE log streaming
  - `column_mapping` object, nullable — Column mapping from source to standard names
  - `dataset_type` string, nullable — Dataset type (ner, classification, custom)

## Response `200`

Successful Response

- DatasetResponse — Response model for a single dataset.
  - `id` string, required
  - `user_id` string, required
  - `dataset_name` string, required
  - `dataset_path` string, required
  - `dataset_type` string, required
  - `size` integer, nullable
  - `sample_size` integer, nullable
  - `train_ratio` number, nullable — Train split ratio for this dataset version. Left-to-right split with no shuffle; validation is the tail.
  - `created_at` string, required
  - `updated_at` string, required
  - `version_number` string
  - `root_dataset_id` string, nullable
  - `project_id` string, nullable
  - `schema` object, nullable
  - `schema_warnings` string[], nullable
  - `validation` object, nullable
  - `annotation_status` 'none' | 'in_progress' | 'completed', nullable
  - `annotation_config` object, nullable
  - `annotation_progress` object, nullable
  - `status` 'initialized' | 'uploading' | 'converting' | 'validating' | 'ready' | 'failed' | 'generating' | 'queued', nullable — Dataset status: initialized/uploading/converting/validating/ready/failed/generating/queued
  - `processing_error` string, nullable — Error message if status is failed
  - `type` string — Dataset purpose tag: 'training', 'evaluation', or 'benchmark'
  - `visibility` string — Dataset visibility: 'private' or 'public'
  - `is_competition` boolean — Whether this dataset is a competition benchmark
  - `labels` string[], nullable — Label names (entity types for NER, class labels for classification)
  - `generation_type` string, nullable — How the dataset was created: synthesize, upload, auto_relabel, manual_relabel, grow, external
  - `is_seed` boolean, nullable — Whether this dataset is a seed dataset (small set for review before full expansion)
  - `synthesis_session_id` string, nullable — UUID of the synthesis log session for this dataset, used to restore creation workflow on resume
  - `column_mapping` object, nullable — Column mapping from original to standard names

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/pioneer/apis/brain-api.md) · [All operations](https://skmtc.net/pioneer/apis/brain-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pioneer/brain-api/versions/31dfe831e079/schema)