For developers
Your agents, callable from code.
List and message your agents, run chat completions, embed text, and search your knowledge folders, all over plain REST. Everything an agent knows in the app, it knows over the API.
request.sh
cURL1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
curl --request POST \
--url $BEAM_URL/v1/chat \
--header 'Authorization: Bearer $BEAM_KEY' \
--header 'Content-Type: application/json' \
--data '{
"message": "Summarize the Q3 board deck.",
"agentId": "agent-analyst"
}'
# 200 OK · 348 tokens · 412ms
{ "id": "chat_a1f9c4", "object": "chat.completion" }
The endpoints. Small on purpose. Every route listed here is live.
GET/v1/meIntrospect the key: workspace, user, role
GET/v1/agentsList the agents your key can see, paginated
GET/v1/agents/{id}Fetch one agent's name, description, and model
POST/v1/agentsCreate an agent
POST/v1/agents/{id}/messagesSend a message to an agent, get its answer
POST/v1/chatOne-shot chat; pass agentId to pick the agent
POST/v1/chat/completionsChat completions (no streaming or tool calls yet)
POST/v1/embeddingsEmbed text with your configured embedding provider
POST/v1/knowledge/querySearch your knowledge folders
Built on open standards. REST for your code, A2A for other agents, MCP for other tools.
Agents over REST
Message any workspace agent from your own software. Same instructions, knowledge, and tools as in the app.
Agent APIREST · v1
POST /v1/agents/{id}/messagescURL
1// Message an agent
2{
3"message": "Research Northlake Foods for our call…",
4}
5// 200 OK
6{ "agentId": "agt_8fa2", "response": "Northlake Foods is a…" }
POST/v1/agents/agt_8fa2/messagesinvoke →
A2A and MCP
Every agent is an Agent-to-Agent JSON-RPC endpoint, and Beam doubles as an MCP server for the rest of your stack.
RESTMCPA2AWebhooksOpenAPI
Questions & answers.
A small, honest REST surface over your workspace: list and message your agents, run chat completions, generate embeddings, and search your knowledge folders. Everything an agent knows (instructions, knowledge, tools) applies to API calls too.