> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ontora.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview Sync

> Preview what would be synced without actually syncing.

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



## OpenAPI

````yaml /openapi.json post /v1/projects/{project_id}/sync/preview
openapi: 3.1.0
info:
  title: Ontora API
  description: >-
    Ontora's public API. Covers interview campaigns, transcripts, synthesis
    reports, graph queries, webhooks, and workspace management. 


    **Authentication**: endpoints accept either a Clerk JWT (`Authorization:
    Bearer <token>`) or a workspace API key (`X-API-Key: ont_...`). Workspace
    keys are managed via `/v1/api-keys`.
  version: 0.1.0
servers: []
security:
  - ClerkJWT: []
  - WorkspaceApiKey: []
tags:
  - name: interviews
    description: Campaign CRUD, lifecycle, contacts, question sets.
  - name: campaign-insights
    description: Synthesis outputs — cartography, roadmap, personas, conversations.
  - name: interview-query
    description: Graph RAG query over campaign data.
  - name: interview-export
    description: Markdown / ZIP exports of transcripts and reports.
  - name: api-keys
    description: Manage workspace-scoped API keys for programmatic access.
  - name: webhook-endpoints
    description: Outbound webhook endpoints for automation.
  - name: booking
    description: Public self-scheduling endpoints for interview participants.
  - name: workspaces
    description: Workspace and membership management.
  - name: vaults
    description: Context vault management.
paths:
  /v1/projects/{project_id}/sync/preview:
    post:
      tags:
        - projects
      summary: Preview Sync
      description: |-
        Preview what would be synced without actually syncing.

        Returns details about each node/edge and what action would be taken.
      operationId: preview_sync_v1_projects__project_id__sync_preview_post
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Project Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyncRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncPreviewResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    SyncRequest:
      properties:
        node_keys:
          items:
            type: string
          type: array
          title: Node Keys
          default: []
        edge_keys:
          items:
            type: string
          type: array
          title: Edge Keys
          default: []
        synced_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Synced By
      type: object
      title: SyncRequest
    SyncPreviewResponse:
      properties:
        nodes:
          items:
            $ref: '#/components/schemas/SyncPreviewNode'
          type: array
          title: Nodes
        edges:
          items:
            $ref: '#/components/schemas/SyncPreviewEdge'
          type: array
          title: Edges
      type: object
      required:
        - nodes
        - edges
      title: SyncPreviewResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SyncPreviewNode:
      properties:
        prj_key:
          type: string
          title: Prj Key
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        node_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Node Type
        target_ukl_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Target Ukl Key
        target_ukl_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Target Ukl Label
        action:
          type: string
          title: Action
        existing_ukl_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Existing Ukl Key
        existing_ukl_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Existing Ukl Name
      type: object
      required:
        - prj_key
        - action
      title: SyncPreviewNode
    SyncPreviewEdge:
      properties:
        edge_key:
          type: string
          title: Edge Key
        from_name:
          anyOf:
            - type: string
            - type: 'null'
          title: From Name
        to_name:
          anyOf:
            - type: string
            - type: 'null'
          title: To Name
        rel_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Rel Type
        action:
          type: string
          title: Action
        from_synced:
          anyOf:
            - type: boolean
            - type: 'null'
          title: From Synced
        to_synced:
          anyOf:
            - type: boolean
            - type: 'null'
          title: To Synced
        from_ukl_key:
          anyOf:
            - type: string
            - type: 'null'
          title: From Ukl Key
        to_ukl_key:
          anyOf:
            - type: string
            - type: 'null'
          title: To Ukl Key
      type: object
      required:
        - edge_key
        - action
      title: SyncPreviewEdge
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ClerkJWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Clerk-issued RS256 JWT.
    WorkspaceApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Workspace-scoped API key (prefix: `ont_`).'
    HTTPBearer:
      type: http
      scheme: bearer

````