1- # BeatAPI CLI and TypeScript Client
1+ <p align =" center " >
2+ <img src =" assets/readme/cover.svg " alt =" BeatAPI CLI and TypeScript SDK — route Agent capabilities from terminal and code " width =" 100% " />
3+ </p >
24
3- Official command-line interface and TypeScript client for BeatAPI's Model,
4- Data, and Workflow capabilities. Version 0.3.0 provides the unified Search,
5- Inspect, Run, and status commands while preserving the existing media,
6- workflow, task, webhook, and Realtime commands.
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 > ·
9+ <a href =" #install-the-cli " >Install</a > ·
10+ <a href =" #command-reference " >Commands</a >
11+ </p >
12+
13+ # BeatAPI CLI and TypeScript SDK
14+
15+ BeatAPI is the ** Agent Router for Everything** : one route to Model, Data, Tool,
16+ and Workspace capabilities. This repository provides the official terminal and
17+ TypeScript interfaces, including the unified Search, Inspect, Run, and status
18+ loop.
19+
20+ ``` bash
21+ npm install --global beatapi
22+ beatapi capabilities search --query video --limit 5
23+ ```
724
825The live catalog is intentionally not hardcoded into the packages. Discover
926current text, image, and video models plus 1,000+ Social Data actions at runtime,
@@ -20,6 +37,15 @@ Both packages are generated and tested against the reviewed OpenAPI snapshot in
2037[ ` contract/beatapi.openapi.yaml ` ] ( ./contract/beatapi.openapi.yaml ) . The lock file
2138records the exact source commit and SHA-256 digest.
2239
40+ ## Where this repository fits
41+
42+ ``` text
43+ Terminal or TypeScript app -> BeatAPI CLI / SDK -> BeatAPI -> Model · Data · Tool · Workspace
44+ ```
45+
46+ The packages route only capabilities exposed by the current BeatAPI catalog and
47+ public contract. They do not hardcode future catalog promises.
48+
2349## Install the CLI
2450
2551Node.js 20.19+ or 22.12+ is required.
@@ -218,3 +244,7 @@ Release steps and ownership prerequisites are documented in
218244## License
219245
220246MIT
247+
248+ <p align =" center " >
249+ Built by <a href =" https://beatapi.io/ " ><strong >BeatAPI</strong ></a > — Agent Router for Everything.
250+ </p >
0 commit comments