---
title: "Preview Sync"
method: POST
path: "/v1/projects/{project_id}/sync/preview"
tags: ["projects"]
---

# Preview Sync

`POST /v1/projects/{project_id}/sync/preview`

Preview what would be synced without actually syncing.

Returns details about each node/edge and what action would be taken.

## Path parameters

- `project_id` string, uuid, required

## Request body

- SyncRequest
  - `node_keys` string[]
  - `edge_keys` string[]
  - `synced_by` string, nullable

## Response `200`

Successful Response

- SyncPreviewResponse
  - `nodes` SyncPreviewNode[], required
    - `prj_key` string, required
    - `name` string, nullable
    - `node_type` string, nullable
    - `target_ukl_key` string, nullable
    - `target_ukl_label` string, nullable
    - `action` string, required
    - `existing_ukl_key` string, nullable
    - `existing_ukl_name` string, nullable
  - `edges` SyncPreviewEdge[], required
    - `edge_key` string, required
    - `from_name` string, nullable
    - `to_name` string, nullable
    - `rel_type` string, nullable
    - `action` string, required
    - `from_synced` boolean, nullable
    - `to_synced` boolean, nullable
    - `from_ukl_key` string, nullable
    - `to_ukl_key` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/ontora/apis/ontora-api.md) · [All operations](https://skmtc.dev/ontora/apis/ontora-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ontora/ontora-api/revisions/7f57037fd94b/schema)