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
12 changes: 7 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.1.0",
"description": "Create and manage BeatAPI AI music video and ecommerce video workflows from Codex.",
"version": "0.2.0",
"description": "Create and manage BeatAPI async and realtime AI video APIs from Codex.",
"author": {
"name": "BeatAPI",
"email": "support@beatapi.io",
Expand All @@ -14,14 +14,15 @@
"beatapi",
"ai-video",
"music-video",
"ecommerce-video"
"ecommerce-video",
"realtime-video"
],
"skills": "./skills/",
"mcpServers": "./.mcp.json",
"interface": {
"displayName": "BeatAPI",
"shortDescription": "Create AI music videos and product ads",
"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 storyboard shots, monitor progress, retrieve hosted results, and configure webhooks.",
"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.",
"developerName": "BeatAPI",
"category": "Creativity",
"capabilities": [
Expand All @@ -34,6 +35,7 @@
"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 create a 60-second realtime session for my web app.",
"Use $beatapi-video to check my credits and task status."
],
"brandColor": "#2563FF",
Expand Down
13 changes: 9 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,16 @@

## Unreleased

## 0.2.0 - 2026-07-31

- Added Realtime Video session create, read, and close MCP tools.
- Store the one-time Realtime browser client secret in a mode-`0600` local file
and keep it out of model-visible tool results.
- Synchronized the canonical Skill, official client runtime, and public OpenAPI
contract to the Realtime baseline.
- Added exact-origin, duration, idempotency, billing, and browser trust-boundary
guidance.
- Prefer bundled MCP execution in the canonical Skill with CLI fallback.
- Distinguish missing authentication from unexpected CLI runtime failures.
- Align MCP usage fixtures with the current BeatAPI OpenAPI contract.
- Clarify that the public Skills-only package does not bundle the local MCP
server and may require the official CLI.

## 0.1.0 - 2026-07-17

Expand Down
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# BeatAPI Codex Plugin

Create and manage BeatAPI AI Music Video and Ecommerce Video workflows 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.
Create and manage BeatAPI asynchronous workflows and Realtime Video sessions
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

Expand All @@ -11,6 +11,7 @@ bundled local MCP server and uses the same API key as the BeatAPI CLI.
- create automatic or manual Music Video tasks;
- inspect, edit, materialize, and compose storyboard shots;
- create Ecommerce Video tasks;
- create, inspect, and close short-lived Realtime Video sessions;
- poll asynchronous tasks until a terminal or actionable state;
- create, inspect, update, and delete webhook endpoints.

Expand All @@ -19,6 +20,11 @@ The plugin does not put API keys in prompts or MCP tool arguments. It first uses
`beatapi` CLI, which reads the key saved by `beatapi auth login` from the
operating-system credential manager.

Realtime creation stores the one-time browser `client_secret` in a local file
with mode `0600`; it is never returned to the model. The agent manages only the
server-side session. Camera permission, WebRTC, and rendering remain in the
browser SDK.

## Install for Codex desktop

Prerequisites:
Expand Down Expand Up @@ -51,6 +57,7 @@ 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_...`.”
- “Create a 60-second Realtime Video session for `https://app.example.com`.”

## Package layout

Expand Down
Loading
Loading