API Reference

CLI quickstart

Install the Synapsor CLI, configure an API key, run SQL, invoke a capability, inspect evidence, preview a proposal, and replay a run.

Overview

Use the CLI from your local terminal when you want copy-pasteable commands, scripts, CI checks, or agent workflow automation.

The CLI uses the same hosted API permissions and quotas as SDK calls. Signed-out visitors should use the public /demo instead of the CLI.

Free invite users can use the CLI within Free hard caps. Builder Beta users get higher CLI and browser Console limits within the same no-overage beta posture.

Developer notes

If no key is configured, create one from the dashboard API key modal.
Store project and database ids from the dashboard or projects/db list commands.
Use --profile for multiple accounts or environments.
Use --base-url only when testing against a non-production controlled-beta endpoint.

First run

Configure once

npm install -g @synapsor/client

# You can also use SYNAPSOR_BASE_URL and SYNAPSOR_API_KEY environment variables.
synapsor config set base-url https://synapsor.ai
synapsor config set api-key

# API keys are created in the signed-in dashboard under Workspace -> API keys.
synapsor config get

Examples

bash

synapsor projects list
synapsor projects create "Acme Support"
synapsor db list --project acme-support
synapsor db create "Support Sandbox" --project acme-support