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

# Initialize cloud sync

> Initialize sync at runtime with credentials.



## OpenAPI

````yaml /openapi.yaml post /sync/init
openapi: 3.0.3
info:
  title: Screenpipe API
  version: 1.0.0
  description: >-
    Screenpipe captures everything you see, say, and hear on your computer. Use
    this API to search through captured content, manage recordings, and build
    AI-powered automations on top of your screen data.


    The server runs locally at `http://localhost:3030` by default.
servers: []
security: []
tags:
  - name: Search
    description: Search through captured screen and audio content
  - name: Frames
    description: Access captured screenshots and their extracted text
  - name: Elements
    description: Query captured UI accessibility tree data
  - name: Audio
    description: Manage audio recording devices
  - name: Vision
    description: Manage screen capture monitors
  - name: Meetings
    description: Detected and manual meeting transcriptions
  - name: Speakers
    description: Speaker identification and management
  - name: Memories
    description: AI-extracted knowledge from screen activity
  - name: Tags
    description: Tag content items for organization
  - name: Activity
    description: Activity summaries and analytics
  - name: Vault
    description: Encrypt/decrypt all data at rest
  - name: Cloud Sync
    description: Sync data across devices via cloud
  - name: Cloud Archive
    description: Archive old data to cloud storage
  - name: Data Retention
    description: Auto-delete old data locally
  - name: Data Management
    description: Manual data deletion and storage info
  - name: Database
    description: Direct database access
  - name: System
    description: Health checks and system status
  - name: Experimental
    description: Experimental/unstable endpoints
paths:
  /sync/init:
    post:
      tags:
        - Cloud Sync
      summary: Initialize cloud sync
      description: Initialize sync at runtime with credentials.
      operationId: sync_api_sync_init
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyncInitRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncInitResponse'
components:
  schemas:
    SyncInitRequest:
      description: Request to initialize sync at runtime.
      type: object
      properties:
        token:
          type: string
        password:
          type: string
        machine_id:
          nullable: true
          type: string
        sync_interval_secs:
          nullable: true
          type: integer
      required:
        - token
        - password
        - machine_id
        - sync_interval_secs
    SyncInitResponse:
      description: Response from sync initialization.
      type: object
      properties:
        success:
          type: boolean
        is_new_user:
          type: boolean
        machine_id:
          type: string
      required:
        - success
        - is_new_user
        - machine_id

````