API documentation
REST API
Eddie AI's REST API: a workspace API key authenticates a CLI you install or an SDK you embed in your own backend. You build request paths and read response bodies, the way any REST client does.
What it is
The REST API is a workspace API key and a set of JSON endpoints under your Eddie web app origin. It is not a client you connect and sign into — there is no session, no OAuth prompt, and nothing to open in a browser. You send a key, you get JSON back.
Two things are built on it: an official command-line client, @eddieai/cli, and the headless SDK the same package ships. Use whichever fits how you are calling it — a shell script reaches for the CLI, a backend service reaches for the SDK.
export EDDIE_API_KEY=sk_live_… id=$(eddie new --import ./interview/*.mov) eddie prompt "$id" "cut a 90s teaser" eddie export "$id" "Teaser" --format mp4
Two ways in: CLI or SDK
- The CLI — install it globally, export your key, and run five commands:
login,new,import,prompt,export. Ids print to stdout, progress to stderr, so a command’s output pipes cleanly into the next one. - The SDK — the same client as a class, for embedding in your own backend rather than shelling out. Dependency-free: Node built-ins and
fetch, nothing else to install.
Both authenticate the same way and drive the same account. The quickstart covers the CLI first and the SDK as a variant of the same steps.
What you can build
- A script that imports the footage from tonight’s shoot, prompts a first assembly, and exports an MP4 before anyone is awake to ask for it.
- A backend job queue that drives Eddie the same way a person would in the app, without a browser or a signed-in session anywhere in the pipeline.
- A CI step that renders a proof cut on every footage delivery and posts the download link somewhere a producer will see it.
At a glance
- Base URL
https://app.heyeddie.ai- Format
- JSON requests and responses.
- Authentication
- A workspace API key,
sk_live_…. How it works. - CLI package
@eddieai/cli- Node version
- 18 or later. The SDK is Node-only — it reads local files to upload.
Where to go next
- QuickstartMint a key, install the CLI, run your first import and prompt.
- AuthenticationWorkspace API keys: minting, the spend gate, and the token exchange.
- Command referenceEvery CLI command and SDK method, with a real example.
- Errors and limitsHTTP status codes, exit codes, and what to retry.
Want a client to sign into and hand tools to instead? The MCP server is the other surface.