Skip to content

README.md

Latest commit

 

History

History
117 lines (86 loc) · 3.45 KB

README.md

File metadata and controls

117 lines (86 loc) · 3.45 KB
Raw

BeatAPI Video Agent Skill

Official Agent Skill for creating, monitoring, and troubleshooting BeatAPI Music Video, Ecommerce Video, and Realtime Video sessions.

The installable Skill is self-contained at:

skills/beatapi-video/

It contains concise orchestration instructions, exact workflow references, safe JSON templates, realistic evaluation prompts, UI metadata, and a reviewed copy of the public BeatAPI OpenAPI contract.

What users can ask

  • “Make a music video from these images and this song.”
  • “Let me choose and edit storyboard shots before composition.”
  • “Create a vertical product ad from these photos.”
  • “Check why my BeatAPI task failed.”
  • “Upload these local inputs and wait for the hosted result.”
  • “Configure BeatAPI success and failure webhooks.”
  • “Create a 60-second Realtime Video session for my web app.”

The Skill prefers BeatAPI MCP tools when the host provides them. The complete Codex plugin bundles those tools. A standalone Skill installation falls back to the official beatapi CLI. Neither adapter asks the user to paste an API key into a conversation.

Requirements

  • A BeatAPI customer account and API key
  • An Agent Skills-compatible host
  • One execution adapter:
    • BeatAPI MCP tools supplied by the host or the complete Codex plugin; or
    • Node.js 20.19+ / 22.12+ and npm install --global beatapi

Create a key at https://beatapi.io/dashboard/apikeys. For a standalone Skill using the CLI fallback, authenticate in a terminal:

beatapi auth login

For MCP servers, CI, or ephemeral environments, set BEATAPI_API_KEY outside the prompt.

Install

Clone the repository and copy or symlink the Skill folder into the host's Skill directory. For a Codex-compatible user installation:

mkdir -p ~/.agents/skills
ln -s /absolute/path/to/beatapi-skill/skills/beatapi-video \
  ~/.agents/skills/beatapi-video

Repository-scoped hosts can place the same folder under their documented local Skills directory. Invoke it explicitly as $beatapi-video or let compatible hosts trigger it from the description.

Codex desktop marketplace distribution is provided by the separate beatapi-codex-plugin repository, which embeds this same Skill.

Contract integrity

The installable folder bundles its own exact OpenAPI snapshot, so it remains self-contained when submitted to Skill directories. Both copies are locked to the reviewed public source:

npm run contract:sync
npm run verify

npm run verify checks contract equality, frontmatter, metadata, linked resources, command guidance, templates, eval coverage, operation IDs, and credential patterns.

Repository structure

skills/beatapi-video/
├── SKILL.md
├── agents/openai.yaml
├── assets/
├── evals/evals.json
└── references/
    ├── api-workflows.md
    ├── beatapi.openapi.yaml
    ├── credits-and-limits.md
    ├── errors-and-recovery.md
    ├── manual-music-video.md
    └── realtime-video.md

See docs/submission-checklist.md before submitting the GitHub repository or Skill folder to a directory.

Build a ready-to-upload ZIP with:

npm run submission:build

The artifact is written to dist/beatapi-video-skill.zip.

Security

Do not place API keys, webhook secrets, private media, or customer task data in prompts, fixtures, screenshots, or public issues. See SECURITY.md.

License

MIT