Comprehensive API documentation for integrating Siya into your applications, workflows, and tools. Whether you’re building extensions, automating tasks, or creating custom integrations, this reference provides everything you need.
The Siya API is currently in development. CLI and REST API access coming soon!
Integrate with Siya Desktop using native macOS technologies
URL Schemes
AppleScript
Shortcuts Integration
Deep Linking Protocol
Control Siya through URL schemes from any application
URL Scheme Reference
Examples
// Open Siya with a promptlet url = URL(string: "siya://chat?prompt=Help%20me%20debug%20this%20Swift%20code")!NSWorkspace.shared.open(url)
// From Electron appconst { shell } = require('electron');shell.openExternal('siya://chat?prompt=Generate%20unit%20tests');
# Open from command lineopen "siya://project?path=$PWD"# With promptopen "siya://chat?prompt=Explain%20this%20error"
<!-- From web page --><a href="siya://chat?prompt=Help%20with%20React"> Ask Siya</a>
URL Parameters
AppleScript Automation
Full automation support through AppleScript
Basic Commands
-- Activate Siyatell application "Siya" activateend tell-- Bring to fronttell application "Siya" activate set frontmost to trueend tell
-- Start new chattell application "Siya" new chatend tell-- Send prompttell application "Siya" new chat with prompt "Generate a Python function"end tell-- Get responsetell application "Siya" set response to last responseend tell
-- Open projecttell application "Siya" open project at path "/Users/me/myproject"end tell-- List projectstell application "Siya" set projectList to projectsend tell
Advanced Automation
-- Complete automation exampletell application "Siya" activate -- Start new chat new chat -- Send complex prompt set myPrompt to "Analyze this code and suggest improvements" send prompt myPrompt -- Wait for completion repeat while is processing delay 0.5 end repeat -- Get and process response set aiResponse to last response -- Save to file save conversation to file "~/Desktop/analysis.md" -- Clear for next task clear memoryend tell
-- Integrate with other appstell application "Finder" set selectedFiles to selectionend telltell application "Siya" activate new chat repeat with aFile in selectedFiles set filePath to POSIX path of (aFile as alias) send prompt "Analyze this file: " & filePath end repeatend tell
AppleScript Dictionary
Apple Shortcuts
Create powerful automations with Shortcuts app
1
Create Shortcut
Open Shortcuts app and create new shortcut
2
Add Siya Action
Search for “Siya” in actions or use URL scheme
3
Configure Action
Set prompt, model, or other parameters
4
Test & Save
Run shortcut and save for reuse
Example Shortcuts
Code Review
1. Get clipboard2. Open URL: siya://chat?prompt=Review%20this%20code%3A%20{clipboard}3. Wait 2 seconds4. Copy Siya response
Daily Standup
1. Get current date2. Open URL: siya://chat?prompt=Generate%20standup%20for%20{date}3. Save response to Notes
import { Siya } from '@siya/sdk';const siya = new Siya({ apiKey: process.env.SIYA_API_KEY});const response = await siya.chat.create({ model: 'claude-opus-4', messages: [...]});
Python
pip install siya-sdk
from siya import Siyaclient = Siya( api_key=os.environ["SIYA_API_KEY"])response = client.chat.create( model="claude-opus-4", messages=[...])
The CLI is currently in development. Expected release: Q1 2025
CLI Preview
Planned Commands
CLI Configuration
# Install via Homebrew (macOS)brew install siya-cli# Install via npmnpm install -g @siya/cli# Install via curlcurl -fsSL https://siya.com/install.sh | sh
# Start interactive sessionsiya chat# One-shot promptsiya ask "Explain this error: ..."# Analyze filesiya analyze main.py# Generate codesiya generate "REST API for user management"
# Use specific modelsiya chat --model claude-opus-4# Project contextsiya --project /path/to/project chat# Pipe inputcat error.log | siya debug# Save outputsiya generate "test suite" > tests.py
Siya’s API ecosystem provides powerful integration capabilities, from simple URL schemes available today to the comprehensive REST API and CLI coming soon. Whether you’re automating workflows, building extensions, or creating custom integrations, Siya’s APIs give you the flexibility and power you need.
Get Started Today
Start with Desktop integration
Stay Updated
Join the developer newsletter
Build on Siya. Extend your capabilities. Create the future.