Documentation

A short path from zero to your first API call.

Quickstart.

Two steps to your first request.

1. 1

   Get an API key

   API keys aren't created from the app yet: ask us (or whoever runs your deployment) and we'll issue one scoped to just what it needs (chat, agents, embeddings, or knowledge). Keep it out of client-side code.

2. 2

   Send your first request

   Message any agent in your workspace with a bearer token. This is the real request shape, no streaming or tool calls in the response yet.

   

   request.sh

   cURL

   1

   2

   3

   4

   5

   6

   7

   8

   9

   10

   11

   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 · 412ms

   { "id": "chat_a1f9c4", "object": "chat.completion" }

The full endpoint list, authentication details, and rate-limit behavior are on the API reference page.