Skip to content

Overview

Show API code examples on this page as

Triggerware is your personal, always-on data platform: a virtual database engine that lets any agent query against external APIs, SaaS tools, and databases as if they were local tables.

When you sign up, you get your own Triggerware instance running in the cloud. This page walks you through some basic use cases of Triggerware.

1. Sign up and get your instance

Section titled “1. Sign up and get your instance”

Go to console.triggerware.ai and create an account. As soon as you sign up, a personal Triggerware instance is provisioned for you — it takes about a minute. From that point on, your instance is always on, dedicated to you, and reachable both through the console and the API.

Click here for a more interactive view of the console documentation.

Click here for a short introduction to our company.

Email info@triggerware.ai with any problems or concerns you may have!

2. Install the CLI (optional)

Section titled “2. Install the CLI (optional)”

Most examples in these docs can be run as either a raw API call or via the Triggerware CLI — use the toggle at the top of any page to switch every code sample.

macOS / Linux:

curl -fsSL https://raw.githubusercontent.com/triggerware/releases/main/install.sh | bash

Windows (PowerShell):

irm https://raw.githubusercontent.com/triggerware/releases/main/install.ps1 | iex

Then you can log in. This command opens up a pop-up in your browser to login, and the CLI will save your credentials for all future commands.

triggerware login

3. Install a connector

Section titled “3. Install a connector”

Your instance starts empty. Connectors are adapters that expose external data sources — PubMed, the SEC EDGAR feed, your Postgres database, anything — as virtual tables you can query. Browse the catalog in the console, or install one directly:

PUT /connectors/installed/{name} 
curl -X PUT https://api.triggerware.com/connectors/installed/<name> \
  -H "Api-Key: YOUR_API_KEY"

See the Connectors page for the full lifecycle — install, configure, run, uninstall, or write your own custom connector from a plain-English prompt.

4. Run a query

Section titled “4. Run a query”

Once a connector is installed, you can query it. Describe what you want in English and Triggerware will generate the SQL:

POST /query 
curl -X POST https://api.triggerware.com/query \
  -H "Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{...}'

Response:

{
  "sql": "select title, year from pubmed_articles where query = 'CRISPR base editing' limit 5",
  "signature": ["title", "year"],
  "rows": [
    ["Programmable base editing of A•T to G•C in genomic DNA", 2024],
    ["..."]
  ]
}

The same endpoint runs raw SQL — pass "language": "sql" instead.

Where to go next

Section titled “Where to go next”