Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions .codex-plugin/plugin.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "beatapi-codex-plugin",
"version": "0.2.0",
"description": "Create and manage BeatAPI async and realtime AI video APIs from Codex.",
"description": "Create and manage BeatAPI image, video, Effect, workflow, and realtime APIs from Codex.",
"author": {
"name": "BeatAPI",
"email": "support@beatapi.io",
Expand All @@ -15,14 +15,17 @@
"ai-video",
"music-video",
"ecommerce-video",
"realtime-video"
"realtime-video",
"image-generation",
"video-generation",
"ai-effects"
],
"skills": "./skills/",
"mcpServers": "./.mcp.json",
"interface": {
"displayName": "BeatAPI",
"shortDescription": "Manage async and realtime AI video APIs",
"longDescription": "Use one existing BeatAPI account and API key from Codex to upload inputs, check credits and concurrency, create asynchronous Music Video and Ecommerce Video tasks, manage short-lived Realtime Video sessions, monitor progress, retrieve hosted results, and configure webhooks.",
"shortDescription": "Manage generation, Effects, workflows, and realtime",
"longDescription": "Use one existing BeatAPI account and API key from Codex to discover public models and Effects, upload inputs, check USD balance and concurrency, create image, video, Effect, Music Video, and Ecommerce Video tasks, manage short-lived Realtime Video sessions, monitor progress, retrieve hosted results, and configure webhooks.",
"developerName": "BeatAPI",
"category": "Creativity",
"capabilities": [
Expand All @@ -35,8 +38,11 @@
"defaultPrompt": [
"Use $beatapi-video to create a music video from my images and audio.",
"Use $beatapi-video to turn my product images into a vertical ad.",
"Use $beatapi-video to generate an image with Nano Banana Pro.",
"Use $beatapi-video to create a Seedance 2.5 video.",
"Use $beatapi-video to list current Effects for this portrait.",
"Use $beatapi-video to create a 60-second realtime session for my web app.",
"Use $beatapi-video to check my credits and task status."
"Use $beatapi-video to check my USD balance and task status."
],
"brandColor": "#2563FF",
"composerIcon": "./assets/icon.png",
Expand Down
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

## Unreleased

- Added MCP tools for text-model discovery, non-streaming text responses,
generation-model discovery, generic image/video generation, versioned
Effects, and Video Analysis.
- Synchronized the canonical Skill, typed client runtime, and OpenAPI snapshot
with the complete 29-operation contract and USD-denominated usage semantics.
- Replaced hardcoded image/video model unions with a stable `model` plus
`parameters` interface so newly published model IDs do not require a plugin
release.
- Added host Configure guidance for `BEATAPI_API_KEY` and kept credentials out
of tool arguments and model-visible results.

## 0.2.0 - 2026-07-31

- Added Realtime Video session create, read, and close MCP tools.
Expand Down
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
# BeatAPI Codex Plugin

Create and manage BeatAPI asynchronous workflows and Realtime Video sessions
Create and manage BeatAPI image, video, Effect, workflow, and Realtime APIs
directly from Codex. The plugin combines the canonical `beatapi-video` Skill
with a bundled local MCP server and uses the same API key as the BeatAPI CLI.

## What users can do

- inspect workflows, credits, usage, and concurrency;
- upload local images, audio, and SRT files;
- discover stable image/video model aliases and published Effects;
- list authenticated text models and create non-streaming text responses only
when the user explicitly asks to use BeatAPI for text;
- create image and video tasks through a model-agnostic request shape, plus
versioned Effect tasks;
- analyze uploaded MP4 or MOV files through the async Video Analysis workflow;
- inspect workflows, USD balance, usage, and concurrency;
- upload local images, audio, video, and SRT files;
- create automatic or manual Music Video tasks;
- inspect, edit, materialize, and compose storyboard shots;
- create Ecommerce Video tasks;
Expand Down Expand Up @@ -56,7 +62,10 @@ Restart the desktop app after installation. Useful starter requests include:

- “Use `$beatapi-video` to create a music video from my images and audio.”
- “Turn these product photos into a 15-second 9:16 ad.”
- “Check my BeatAPI credits and the status of task `task_...`.”
- “Generate an image with Nano Banana Pro.”
- “Make a 10-second Seedance 2.5 video with these references.”
- “List the current Effects and run one on this portrait.”
- “Check my BeatAPI balance and the status of task `task_...`.”
- “Create a 60-second Realtime Video session for `https://app.example.com`.”

## Package layout
Expand Down
Loading
Loading