---
title: "Initialize cloud sync"
method: POST
path: "/sync/init"
tags: ["Cloud Sync"]
---

# Initialize cloud sync

`POST /sync/init`

Initialize sync at runtime with credentials.

## Request body

- SyncInitRequest — Request to initialize sync at runtime.
  - `token` string, required
  - `password` string, required
  - `machine_id` string, nullable, required
  - `sync_interval_secs` integer, nullable, required

## Response `200`

OK

- SyncInitResponse — Response from sync initialization.
  - `success` boolean, required
  - `is_new_user` boolean, required
  - `machine_id` string, required

## Changes

> 10 revisions in range; 1 could not be searched.

- **2026-04-09** `0f0f8030c7e2` — 1 info
  - api tag `Cloud Sync` added
- **2026-04-08** `1a63468a8d30` — 2 breaking, 3 info
  - the request property `machine_id` became required
  - the request property `sync_interval_secs` became required
  - api operation id `server_sync_init` removed and replaced with `sync_api_sync_init`
  - api tag `Cloud Sync` removed
  - …1 more
- **2026-02-16** `e143bf8d73bc` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/screenpipe/apis/screenpipe-api/changes/sync/init/post.md)

---

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