Audream exposes several interfaces because one credential and interaction model is not appropriate for every workflow. Start with where the code runs and whose intent it represents.
REST API for trusted application services
Use REST when your backend owns the integration and can protect an Audream API key. Keep the key in a trusted server environment, never in browser code, a mobile binary, firmware, a public repository, or telemetry.
The current API supports asynchronous work. Retain the returned Note ID, distinguish queued and processing from terminal outcomes, and use bounded polling. Do not invent a successful result when the service reports a terminal error.
CLI for local files and shell automation
Use the Audream CLI when an authorized user or operator wants to upload local audio, inspect Notes, wait for processing, or emit JSON into a script. The current package requires Node.js 20 or newer and installs from the public GitHub repository.
The CLI is not an offline transcription engine or a credential vault. Permanent deletion requires an exact confirmation value so a copied command cannot silently delete the wrong Note.
MCP for interactive agent access
Use remote MCP when a compatible agent client should act for a user through OAuth. Scopes separate reading, writing, processing, and deletion. The client should request the narrowest set needed for the current task, and the user must be able to revoke the connection.
Supporting Note IDs identify the Notes used for an answer. They are not a promise of exact paragraph, turn, or audio-time citations.
Agent Skill for repeatable workflow guidance
The Audream Skill teaches an Agent Skills-compatible host how to choose among MCP, CLI, and REST, retain identifiers, poll asynchronous work, preserve sources, and confirm destructive actions. It does not replace those interfaces or contain a secret.
Use the Developer Hub for the decision overview and the published developer documentation for current installation and connection details.
