Skip to main content

​
API Reference

Sontairo exposes a REST API for programmatic access to all platform features.

​
Base URL

https://sontairo.com/api
For self-hosted deployments, replace with your instance URL.

​
Authentication

All API requests require authentication via session cookies (for browser-based access) or API tokens. See Authentication for details.

​
Response Format

All API endpoints return JSON with a consistent structure:

​
Success

{
  "data": { ... }
}

​
Error

{
  "error": "Human-readable error message"
}

​
Common Parameters

ParameterDescription
workspaceIdRequired. The workspace to operate in.
projectIdOptional. Scopes the request to a specific project.