---
title: "Starts a HuggingFace sync of the benchmark and returns its current sync status."
method: POST
path: "/benchmark/{benchmarkId}/huggingface-sync"
tags: ["Benchmark", "HuggingFaceSync"]
---

# Starts a HuggingFace sync of the benchmark and returns its current sync status.

`POST /benchmark/{benchmarkId}/huggingface-sync`

Responds 409 Conflict when a sync is already in progress for the benchmark, or when a repo
 name is supplied that differs from the one an earlier successful sync established. The repo
 name is only honored while the benchmark has never completed a sync.

## Path parameters

- `benchmarkId` string, required

## Request body

- StartBenchmarkHuggingFaceSyncEndpointInput
  - `repoName` string, nullable — Optional target repo name. Only honored while the benchmark has never completed a sync; defaults to a name derived from the benchmark name.
  - `fullRebuild` boolean, nullable — When true, re-export the entire benchmark as a non-incremental sync. Defaults to false.

## Response `200`

OK

- StartBenchmarkHuggingFaceSyncEndpointOutput
  - `status` 'NeverSynced' | 'Exporting' | 'Uploading' | 'Completed' | 'Failed', required
  - `outcome` 'CreatedPrivate' | 'UpdatedPrivate' | 'OpenedPullRequest' | 'Failed' | 'null', nullable — Outcome of the last completed attempt, or null when none has completed.
  - `repoId` string, nullable — The target HuggingFace repo id (e.g. Rapidata/svg-benchmark), or null.
  - `repoUrl` string, nullable — URL of the HuggingFace repo, or null when not yet known.
  - `prUrl` string, nullable — URL of the review pull request opened by the last attempt, or null.
  - `lastSyncedAt` string, date-time, nullable — When the benchmark was last successfully synced, or null.
  - `lastError` string, nullable — The error from the last failed attempt, or null.

## Other responses

- `400` — Bad Request
- `401` — Unauthenticated
- `403` — Forbidden

---

[API](https://skmtc.net/rapidata/apis/rapidata-api.md) · [All operations](https://skmtc.net/rapidata/apis/rapidata-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rapidata/rapidata-api/revisions/d779de93a5ee/schema)
