|
1 | 1 | <p align="center"> |
2 | | - <img src="assets/readme/cover.svg" alt="BeatAPI Agent Plugin connects Codex, Cursor, Grok Bot, and Grok Build to BeatAPI text, image, video, and workflow APIs" width="100%" /> |
| 2 | + <img src="assets/readme/cover.svg" alt="BeatAPI Agent Plugin — connect Agent hosts to Model, Data, Tool, and Workspace capabilities" width="100%" /> |
3 | 3 | </p> |
4 | 4 |
|
5 | 5 | <p align="center"> |
| 6 | + <a href="https://beatapi.io/"><strong>Explore BeatAPI</strong></a> · |
| 7 | + <a href="https://beatapi.io/dashboard/apikeys">Create an API key</a> · |
| 8 | + <a href="https://docs.beatapi.io/">Docs</a> · |
6 | 9 | <a href="#quick-start">Quick start</a> · |
7 | | - <a href="#model-coverage">Model coverage</a> · |
8 | 10 | <a href="#api-key-and-secret-safety">Security</a> · |
9 | 11 | <a href="#verification">Verification</a> |
10 | 12 | </p> |
11 | 13 |
|
12 | 14 | # BeatAPI Agent Plugin |
13 | 15 |
|
14 | | -For a host-independent onboarding prompt, use |
15 | | -`set up https://beatapi.io/SKILL.md`. The repository root [`SKILL.md`](SKILL.md) |
16 | | -mirrors that setup contract; the detailed installable Skill remains under |
17 | | -`skills/beatapi-video/`. |
| 16 | +BeatAPI is the **Agent Router for Everything**: one route to Model, Data, Tool, |
| 17 | +and Workspace capabilities. This plugin connects Codex, Cursor, Grok Bot, and |
| 18 | +Grok Build to BeatAPI through a bundled Skill, local MCP server, typed client, |
| 19 | +and locked public contract. |
18 | 20 |
|
19 | | -A cross-host Agent Toolkit plugin for discovering live BeatAPI Model, Social |
20 | | -Data, and Workflow capabilities and running text, image, video, Effect, |
21 | | -analysis, and production APIs through one local MCP interface. |
| 21 | +For host-independent onboarding, give an Agent this instruction: |
| 22 | + |
| 23 | +```text |
| 24 | +set up https://beatapi.io/SKILL.md |
| 25 | +``` |
| 26 | + |
| 27 | +The repository root [`SKILL.md`](SKILL.md) mirrors that setup contract; the |
| 28 | +detailed installable Skill remains under `skills/beatapi-video/`. |
22 | 29 |
|
23 | 30 | For hosts that support remote MCP, BeatAPI also provides the stable Hosted MCP |
24 | 31 | endpoint `https://beatapi.io/mcp` with three provider-neutral tools: |
25 | 32 | `capabilities_search`, `capabilities_inspect`, and `capabilities_run`. The |
26 | 33 | bundled local MCP keeps focused workflow, upload, account, and task tools for |
27 | 34 | host-native use; both surfaces discover model IDs dynamically. |
28 | 35 |
|
| 36 | +## How it routes |
| 37 | + |
| 38 | +```text |
| 39 | +Codex · Cursor · Grok -> Skill + local MCP -> BeatAPI -> Model · Data · Tool · Workspace |
| 40 | +``` |
| 41 | + |
| 42 | +The plugin exposes only capabilities supported by its current public contract |
| 43 | +and the live catalog. Tool and Workspace coverage expands through reviewed |
| 44 | +interfaces and integrations rather than README-only claims. |
| 45 | + |
29 | 46 | The repository packages the same canonical `beatapi-video` Skill, bundled MCP |
30 | 47 | server, typed client, and locked OpenAPI contract for four agent surfaces: |
31 | 48 |
|
@@ -264,3 +281,7 @@ before opening a pull request. |
264 | 281 | ## License |
265 | 282 |
|
266 | 283 | MIT |
| 284 | + |
| 285 | +<p align="center"> |
| 286 | + Built by <a href="https://beatapi.io/"><strong>BeatAPI</strong></a> — Agent Router for Everything. |
| 287 | +</p> |
0 commit comments