Developers
Use the public API from your own systems, or let an AI assistant work with Ghostpull through MCP. Both use your account's Addons and media library, with different authentication and available actions.
| Public API | MCP | |
|---|---|---|
| Use it for | Scripts and integrations | Connected AI assistants |
| Authenticate with | An account API key in x-api-key | Your Ghostpull login and OAuth consent |
| Available actions | List Addons, upload and read media, import and read products, analyze and manage brands, start, follow and redo runs and batches | Upload and read media, import and read products, analyze and manage brands, check credits, start and follow runs, read your profile and change your name |
| Start here | API quickstart | Connect through MCP |
| Reference | API reference v1 | MCP tools |
The public API is in preview. Check the live API contract or
the connected server's tools/list before relying on an operation.
API
Start with the API quickstart, then give your key only the permissions it needs. Follow the guides to upload media, start runs, follow them, run batches and make and edit image ads. The API reference describes each operation's fields and responses.
MCP
Connect an assistant, try a workflow, and see the tool list. The assistant reads each tool's exact inputs and outputs from the server. MCP tools act for the account you connected; account API keys do not work at the MCP endpoint.
To use Ghostpull in the web app, start with the user guides.