Explore BeatAPI · Create an API key · Agent setup · Install
BeatAPI is the Agent Router for Everything: one route to Model, Data, Tool, and Workspace capabilities. This repository teaches Agent Skills-compatible hosts when and how to discover, inspect, and run the capabilities currently available through BeatAPI.
Give a compatible Agent this one-line setup instruction:
set up https://beatapi.io/SKILL.md
The public, agent-readable setup entrypoint is SKILL.md. It gives
the shortest path from a BeatAPI key to the unified Search → Inspect → Run loop.
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.
Agent host -> BeatAPI Skill -> CLI or MCP -> BeatAPI -> Model · Data · Tool · Workspace
The Skill reflects the current public catalog and contract. Model and Social Data capabilities are discoverable today; Tool and Workspace routes depend on the interfaces and integrations available to the connected host.
- “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.”
- “Search and run a Social Data action through BeatAPI.”
- “Create a 60-second Realtime Video session for my web app.”
The Skill prefers the Hosted MCP Search → Inspect → Run loop when the host
provides it. The complete Agent Plugin also bundles focused local MCP tools. A
standalone Skill installation falls back to the official beatapi CLI. None
of these adapters asks the user to paste an API key into a conversation.
- A BeatAPI customer account and API key
- An Agent Skills-compatible host
- One execution adapter:
- BeatAPI Hosted MCP or local tools supplied by the complete Agent 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 loginFor MCP servers, CI, or ephemeral environments, set BEATAPI_API_KEY outside
the prompt.
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-videoRepository-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.
Cross-host plugin distribution is provided by the separate
beatapi-agent-plugin repository, which embeds this same Skill.
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 verifynpm run verify checks contract equality, frontmatter, metadata, linked
resources, command guidance, templates, eval coverage, operation IDs, and
credential patterns.
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:buildThe artifact is written to dist/beatapi-video-skill.zip.
Do not place API keys, webhook secrets, private media, or customer task data in prompts, fixtures, screenshots, or public issues. See SECURITY.md.
MIT
Built by BeatAPI — Agent Router for Everything.