---
title: "Plan Sync"
method: POST
path: "/v1/sync/plan"
tags: ["Public API v1 - Local Markdown Sync"]
---

# Plan Sync

`POST /v1/sync/plan`

## Request

- Base URL: `https://api.corvio.ai`
- URL: `https://api.corvio.ai/v1/sync/plan`
- Auth: HTTP bearer

## Request body

- PublicSyncPlanRequest
  - `source_id` string, uuid, required
  - `local` PublicSyncManifestItem[]
    - `relative_path` string, required
    - `content_sha256` string, nullable
    - `size_bytes` integer, nullable
    - `mtime_ms` integer, nullable
    - `page_id` string, uuid, nullable

## Response `200`

Successful Response

- PublicSyncPlanResponse
  - `source` PublicSyncSource, required
    - `id` string, uuid, required
    - `root_node_id` string, uuid, required
    - `folder_name` string, required
    - `client_id` string, nullable
    - `mirror_root_dir` string
    - `status` string, required
    - `last_pull_at` string, date-time, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `actions` PublicSyncPlanAction[], required
    - `action` 'pull' | 'push' | 'unchanged' | 'conflict' | 'local_missing', required
    - `relative_path` string, required
    - `page_id` string, uuid, nullable
    - `conflict_id` string, uuid, nullable
    - `reason` string, nullable
    - `remote` PublicSyncRemoteItem
      - `page_id` string, uuid, required
      - `node_id` string, uuid, required
      - `title` string, required
      - `relative_path` string, required
      - `markdown` string, required
      - `content_sha256` string, required
      - `content_revision` integer, required
  - `counts` object, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/corvio/apis/corvio-developer-api.md) · [All operations](https://skmtc.dev/corvio/apis/corvio-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/corvio/apis/corvio-developer-api/revisions/a5a77bb9619c?raw)