Developer platform & API

The CLI and TypeScript SDK

Upload, watch a folder, and query your vault from the terminal or Node.

3 min read · Updated June 28, 2026


Two first-party tools sit on top of the REST API: a command-line tool and a dependency-free TypeScript/JavaScript SDK. Both authenticate with an API key.

CLI

Point it at your key with STOATIFY_API_KEY=sk_... and run:

  • stoatify whoami, confirm your key works.
  • stoatify upload file.pdf, upload one or more files.
  • stoatify ls and stoatify query "text", list and search documents.
  • stoatify watch ./inbox, watch a folder and stream new files into your vault (add -delete to remove each after upload).

SDK

Install @stoatify/sdk and create a client with your key to script the API from Node or the browser. It's tiny and dependency-free:

  • client.documents.list(), .get(id), and .upload(...).
  • client.search("..."), client.tags.list(), client.categories.list().
  • Errors carry a status and code you can branch on.

Good to know

For no-code automation and connecting other tools, see Integrations and automation.

Was this article helpful?

Ready to try it?

Open your vault and put this into practice.

Open app