Skip to content
OpenPromo
Get started

Docs

OpenPromo docs

Start with the setup guide and how OpenPromo works, then run it yourself or connect your AI agent. The reference pages cover the MCP server, the REST API and every error code.

Start here

Set up your account, make your first post, and see what each action costs.

  1. Getting started

    Get started with OpenPromo: add your YepAPI key, set a spending limit, add your website, check the brand profile and make your first post or reel.

  2. How OpenPromo works

    How OpenPromo works: reading a website into a brand profile, ideas, creations as scenes, checks, rendering with templates and video, and what is stored.

  3. Costs, caching and limits

    What each action costs on your YepAPI key, what is cached so you do not pay twice, where to see your usage and how the monthly spending limit works.

Run it yourself

Run the whole stack on your own machine or server.

  1. Self-hosting

    How to self-host OpenPromo with Docker: one command on your computer or a cloud server, HTTPS for your own domain, media storage, updates and backups.

Reference

The details: connecting agents, every MCP tool, API route and error code.

  1. Connect your agent

    Connect Claude, ChatGPT, Cursor or Codex to the OpenPromo marketing MCP server: OAuth or an API key, a setup prompt, and skills for posts and reels.

  2. MCP tools

    Every tool of the OpenPromo MCP server: account, projects and brand, ideas, creations, renders and the library, with what each one does and costs.

  3. REST API

    The OpenPromo REST API: API keys, the response format and every route for projects, brand profiles, assets, ideas, creations, renders and usage.

  4. Errors and troubleshooting

    OpenPromo error codes and what to do about them: missing or rejected YepAPI keys, the spending limit, brand profiles that are not ready and failed renders.

OpenPromo is an early project in active development. The docs describe what the current version does.