Meine erste Kampagne erstellen
Dokumentationsmenü
Dokumentation

API

Generate banner concepts, in all the sizes and locales you ask for, from your own system, your AI assistant or your design. For developers.

Authenticationbm_live_ and bm_test_ keys, permissions and best practices for using the API.Errors and limitsThe error format, each status code, and the requests-per-minute limit.IdempotencyRetry without duplicating or charging twice with the Idempotency-Key header.Create a bannerCreates a concept in all the sizes and locales you ask for. Responds 202 with a job; check its status or wait for the webhook.Get a bannerReads the spec, the current version, the pieces and the texts of a concept, or lists the concepts in your workspace.Correct and adapt a bannerCorrect a concept with a plain-language instruction or add new sizes to it. They respond 202 with a job.CampaignsList the campaigns in your workspace, archive them, and add or remove locales.Job statusCheck a generation job or follow it live with SSE events.ExportsBuild the .zip packages for an ad platform, follow their status and download them checking the sha-256.File libraryUpload images, logos and fonts to the workspace library, list them and remove them.Estimate creditsFind out how many credits an operation would cost and what your balance is, without reserving anything.Public modelsCheck, without a key, which version of each AI model BannerMotion uses today.WebhooksReceive signed notices on your server: how to create the endpoint, verify the signature and handle retries.Webhook eventsThe 13 events, all emitted today: when they fire, what the data field carries and an example of each.MCP serverConnect Claude, Cursor or ChatGPT to BannerMotion: 10 tools to generate, correct, view and export banners.SDKs and OpenAPITypeScript and Python clients, the OpenAPI 3.1 specification and the API's llms.txt.Figma plugin and moreThe Figma plugin, the Claude Code skill and the Cursor setup: what each one does and where it stands.