Skip to main content
This API is unstable. Endpoints, request/response shapes, and authentication requirements may change without notice. Do not build production integrations against these endpoints without contacting the Omnara team first.

Overview

The Omnara API is a RESTful JSON API served over HTTPS. All endpoints are prefixed with /api/v1 and require authentication via a Bearer token in the Authorization header.

Authentication

Most endpoints require a valid Bearer token. You can obtain one by creating a Personal Access Token (PAT) in the Omnara dashboard, or by using the CLI authentication flow.
curl -H "Authorization: Bearer <your-token>" \
  https://api.omnara.com/api/v1/machines
See the Authentication guide for full details.

Base URL

EnvironmentURL
Productionhttps://api.omnara.com
Local developmenthttp://localhost:8000

Endpoint groups

GroupDescription
AuthPersonal access tokens, user profiles
RelayRelay instance registration and token refresh
SettingsUser notification preferences
SessionsUser session lifecycle and chat messages
MachinesRegister and list connected machines
WorkspacesManage workspaces and launch sessions
WorktreesGit worktree management and migration