Skip to content
Obscura Flow

API reference

API reference

Section titled “API reference”

This page summarizes the two API surfaces used by Obscura Flow:

  • the renderer IPC API exposed through window.obscuraFlow;
  • the backend REST API used by the application API client.

Renderer API

Section titled “Renderer API”

The renderer API handles local workspace operations, settings, authentication, API health checks, project actions, EXIF scans, and archive actions.

Key operations include:

  • getBootstrapState() to load the initial application state;
  • createWorkspace(params) to create a local workspace and queue or run API synchronization;
  • openWorkspace() and openRecentWorkspace(filePath) to open workspaces;
  • showWorkspaces() to load local and remote workspace lists;
  • archiveProject(params) to create an archive and persist archive history;
  • cancelArchive(projectId) to request cancellation of an archive in progress.

Backend REST API

Section titled “Backend REST API”

The backend stores synchronized workspaces, projects, collections, archives, and sync operations. The configured API base URL is visible in the application settings.

Section titled “Related documentation”