Build with
Boids agents.
Use the Boids API and CLI to call agents, embed them into apps, and keep every run connected to Console.
Run your first Boids agent in 60 seconds.
Read →Agent Runs APIStart and monitor an agent run from your app.
Read →CLIRun agents locally, in scripts, or in CI.
Read →CreditsUnderstand usage, multipliers, and billing.
Read →Quickstart
Install the CLI or SDK and export your API key. Boids lets you call agents from code, CI, or a local terminal session.
npm install @boids/sdk
npm install -g @boids/cli
export BOIDS_API_KEY=bd_...import { Boids } from "@boids/sdk";
const boids = new Boids({
apiKey: process.env.BOIDS_API_KEY,
});
const run = await boids.agents.runs.create({
agent: "github/pr-reviewer",
input: {
repo: "acme/api",
pull_request: 42,
goal: "find risky changes and suggest the smallest patch",
},
});
console.log(run.output.summary);Authentication
All requests require an Authorization header with a key starting with bd_. Provision keys per project from your console.
Authorization: Bearer $BOIDS_API_KEY
Content-Type: application/jsonAgent Runs
The /agents/runs endpoint starts an agent from the Boids directory. Each agent declares its own input schema, tools, and artifacts.
curl https://api.boids.ai/v1/agents/runs \
-h "authorization: bearer $BOIDS_API_KEY" \
-h "content-type: application/json" \
-d '{
"agent": "research/web-scout",
"input": {
"query": "best alternatives to vector databases for agent memory",
"depth": "brief"
}
}'Streaming
Set stream: true to receive planning events, tool calls, partial output, and artifacts as the agent works.
const stream = await boids.agents.runs.stream({
agent: "browser/operator",
input: { task: "open the pricing page and extract the plan limits" },
});
for await (const event of stream) {
console.log(event.type, event.data);
}Tools & Function Calling
Agents can request tools through Boids, including GitHub, Slack, browser automation, databases, and internal HTTP endpoints. Your policy decides which tools each agent can use.
await boids.policies.update("prod", {
agents: ["github/pr-reviewer", "linear/issue-triage"],
tools: ["github.read", "github.comment", "linear.write"],
approvals: {
"github.merge": "manual",
"billing.charge": "blocked"
}
});Errors & Retries
When an agent provider degrades, Boids retries safe steps, preserves the run log, and returns enough state for your app or CI job to resume.
{
"agent": "github/pr-reviewer",
"idempotency_key": "pr-42-review",
"retry": {
"safe_tools": true,
"max_attempts": 2,
"resume_from_last_event": true
}
}Boids CLI
Use the CLI when you want agents in local development, CI, or release workflows without writing integration code first.
boids run github/pr-reviewer \
--repo acme/api \
--pull-request 42 \
--policy prod
boids runs tail --latestRate Limits
Default limits are 600 agent runs per minute and 8M tool tokens per key. Team plans can reserve capacity for high-volume agents.
Token Credits
Some agents have fixed token multipliers. Token Credits are calculated from usage volume and the agent's multiplier.
token_credits = tokens * agent.multiplier
// example
2_000_000 tokens * 1.8x = 3_600_000 token creditsStatus
Live availability across agents and tool connectors is published at status.boids.ai. You can subscribe to incident updates via Slack, Discord or webhook.
Provision a key and put your first Boids agent in motion.