Developer documentation
Eddie AI API
Eddie AI has two developer surfaces: a key-based REST API for a CLI or your own backend, and a Model Context Protocol server for agent clients like Claude and ChatGPT. Both work against the same account and the same projects.
Two surfaces, one account
Eddie AI publishes two developer surfaces. Both work against the same account, the same workspace, and the same projects — a share you create through one is a share you can open through the other. They differ in how you authenticate and in the shape of the calls you make, not in what Eddie can do.
REST API
A workspace API key, a CLI, and a headless SDK.
Mint a key, install @eddieai/cli, and drive a project from a shell or your own backend — create, import, prompt and export, over ordinary JSON endpoints.
Agent-nativeMCP server
Connect a client and every editing action becomes a tool call.
One OAuth-protected endpoint. Point Claude, ChatGPT, Claude Code or any Model Context Protocol client at it, sign in with your Eddie account, and the tools arrive typed.
Which one you want
- Writing a script, a cron job, or a backend service? Use the REST API. A workspace API key authenticates it, so there is no client to sign in and no session to keep alive.
- Handing Eddie to an agent, or working inside Claude or ChatGPT? Use the MCP server. Editing actions arrive as typed tools with their own schema, which is what an agent needs to decide what to call and why.
- Not sure? If you are writing the calling code yourself, start with the REST API — a key and a CLI command are the fastest way to see a real result. If something else is deciding what to call, that is what MCP is for.
The mental model
Both surfaces share one idea: a share is a project. It holds the media you imported, and it holds the edits built from that media. Sources are imported and analysed; an edit is built from them; refinements change one edit and leave the sources and the other edits alone; delivery turns an edit into a file. Each surface’s own overview covers this in more depth, in the terms of its own calls.
Where to go next
- REST APIA workspace API key, a CLI, and a headless SDK.
- MCP serverConnect an MCP client and every editing action becomes a tool call.
Building from a shell and want the command-line client without reading either surface first? Start with the REST quickstart. It has you running a real import in a few minutes.