API Reference

Datasets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Publish a dataset to an external platform

datasets.publish(strdataset_id, DatasetPublishParams**kwargs) -> DatasetPublishResponse

POST/api/v1/datasets/{dataset_id}/publish

Publishes the processed dataset to Hugging Face or Kaggle. Currently returns 501 — not yet implemented.

ParametersExpand Collapse

dataset_id: str

target: Literal["huggingface", "kaggle"]

Destination platform for publishing the dataset

One of the following:

"huggingface"

"kaggle"

target_spec: Optional[Dict[str, object]]

Target-specific configuration (e.g. repo name for HuggingFace, slug for Kaggle)

ReturnsExpand Collapse

class DatasetPublishResponse: …

publish_id: str

Unique identifier for the publish job

status: str

Status of the publish job

message: Optional[str]

Additional information about the publish request

Publish a dataset to an external platform

Python

HTTP

TypeScript

Python

import os
from adaption import Adaption

client = Adaption(
    api_key=os.environ.get("ADAPTION_API_KEY"),  # This is the default and can be omitted
)
response = client.datasets.publish(
    dataset_id="dataset_id",
    target="huggingface",
)
print(response.publish_id)

200 example

{
  "publish_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "message": "message"
}

Returns Examples

200 example

{
  "publish_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "message": "message"
}