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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## 0.3.0 — 2026-10-02

- Ship current capability, result-view and Web guidance in the installable Skill and synchronize its OpenAPI.


## [Unreleased]

### Changed
Expand Down
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

# BeatAPI Agent Skill

BeatAPI is the **Agent Router for Everything**: one route to Model, Data, Tool,
BeatAPI is the **professional capability layer for any agent**: 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.
Expand All @@ -38,7 +38,7 @@ copy of the public BeatAPI OpenAPI contract.
## Where this repository fits

```text
Agent host -> BeatAPI Skill -> CLI or MCP -> BeatAPI -> Model · Data · Tool · Workspace
Agent host -> BeatAPI Skill -> CLI or MCP -> BeatAPI -> Models · Social Data · SEO Data · Web Search · Workflows
```

The Skill reflects the current public catalog and contract. Model and Social
Expand Down Expand Up @@ -150,5 +150,13 @@ prompts, fixtures, screenshots, or public issues. See [SECURITY.md](SECURITY.md)
MIT

<p align="center">
Built by <a href="https://beatapi.io/"><strong>BeatAPI</strong></a> — Agent Router for Everything.
Built by <a href="https://beatapi.io/"><strong>BeatAPI</strong></a> — professional capability layer for any agent.
</p>

## Current gateway update (0.3.0)

The installable `beatapi-video` Skill retains its existing install name and media
recipes, and now carries the current general capability guide and Web references.
It teaches readiness, schema hashes, preview, field projection and free stored
result reads. It supports the bundled MCP 0.4.0 and CLI 0.4.0 interfaces. Search
and Inspect define availability and pricing; model lists are discovered at runtime.
1,761 changes: 1,472 additions & 289 deletions contract/beatapi.openapi.yaml

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions contract/contract.lock.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"source": "https://github.com/BeatAPI/beatapi-examples",
"ref": "586c5f9227d87c763d7b647af593ec45284abbba",
"ref": "82af055182f9a9848f2e405395b96f3f67c79b6c",
"openapiVersion": "1.0.0-launch",
"sha256": "0dfcad26d8a7086576085dd721011222c3176fc657dfc5b23ce47f42340607ae"
"sha256": "520937b0c2c3e3671a2c5d4ba0a2c0e822343f98599474a6e6e4fe545a5889d8"
}
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "beatapi-skill",
"version": "0.2.0",
"version": "0.3.0",
"private": true,
"description": "Official Agent Skill for BeatAPI, the Agent Router for Everything.",
"description": "Official Agent Skill for BeatAPI, the professional capability layer for any agent.",
"type": "module",
"scripts": {
"contract:sync": "node scripts/contract.mjs --write",
Expand Down
8 changes: 8 additions & 0 deletions scripts/validate-skill.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,14 @@ for (const relativePath of linkedResources) {
}

const requiredCommands = [
"capabilities_search",
"capabilities_inspect",
"capabilities_run",
"web_search",
"web_read",
"web_map",
"web_research",
"capabilities result",
"beatapi auth status",
"beatapi workflows list",
"beatapi usage",
Expand Down
20 changes: 16 additions & 4 deletions skills/beatapi-video/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,29 @@
---
name: beatapi-video
description: Use when a user asks an agent to call BeatAPI Model, Social Data, or Workflow capabilities. Prefer bundled MCP tools when available or the official CLI as a fallback; covers text, image, video, social-data actions, Effects, Music Video, Ecommerce Video, Video Analysis, Realtime sessions, task monitoring, usage, webhooks, and API errors.
description: Use when a user asks an agent to call BeatAPI Model, Social Data, SEO Data, Web Search, or Workflow capabilities. Prefer bundled MCP tools when available or the official CLI as a fallback; covers text, image, video, social-data actions, Effects, Music Video, Ecommerce Video, Video Analysis, Realtime sessions, task monitoring, usage, webhooks, and API errors.
---

# BeatAPI Agent Toolkit

## Current gateway contract

Read [current.md](references/current.md) for the current Search → Inspect → Run
loop, readiness, next calls, preview and stored result reads. It applies to text,
image, video, decision, social data, SEO data and Web capabilities. Availability
and price come from live Search and Inspect; never hardcode a list of models.

Use `web_search`, `web_read`, `web_map`, `web_research` when available. Read
[web-search.md](references/web-search.md) for fields and research polling.
The official CLI 0.4.0 adds `capabilities result`, view/fields controls and
`beatapi web search|read|map|research --file`. Check installed help first.

## Use the unified capability surface

For Model, Data, or Workflow work, prefer the three provider-neutral capability tools when the host supplies them:

1. `capabilities_search` — find a small candidate page;
2. `capabilities_inspect` — read the exact input, output, pagination, limits, execution mode, and validation state;
3. `capabilities_run` — start the selected capability or query a task with `operation: "status"`.
2. `capabilities_inspect` — read the exact input, output, pagination, limits, execution mode, and readiness and schema hash;
3. `capabilities_run` — start the selected capability or query a task with `operation: "status"`; use `operation: "result"` with the returned request ID to read a stored result, free within one hour.

Capability references use `model:<id>`, `data:<id>`, and `workflow:<id>`. Do not guess an action or parameter from a name. Inspect first when the contract is unknown. Existing `beatapi_*` tools and CLI commands remain compatible for hosts that have not upgraded.

Expand All @@ -26,7 +38,7 @@ before constructing input. Never guess missing fields.
## Choose the execution adapter

Prefer the bundled BeatAPI MCP tools when `beatapi_check_setup` is available.
Use `beatapi_*` tools for the complete workflow and do not shell out to the CLI
Prefer `capabilities_*` and `web_*`; use `beatapi_*` tools for specialized workflows and do not shell out to the CLI
for the same operation.

When BeatAPI MCP tools are unavailable, fall back to the official `beatapi` CLI
Expand Down
Loading
Loading