Base URL
All API requests should be made to:Authentication
The Beam AI API uses bearer token authentication. You’ll need to:- Obtain an access token using your API key
- Include the token in the
Authorizationheader of subsequent requests - Include your
current-workspace-idheader for workspace-specific operations
Quick Start
Here’s a simple example to get you started:API Sections
Authentication
Manage access tokens and authentication for API requests.Users
Retrieve information about authenticated users and their workspaces.Agents
List and manage AI agents in your workspace.Agent Graphs
Access agent workflow structures and configurations.Agent Tasks
Create, monitor, and analyze agent task executions.Error Handling
The API uses standard HTTP status codes:200- Success201- Created400- Bad Request (invalid parameters)401- Unauthorized (invalid or missing token)403- Forbidden (insufficient permissions)404- Not Found500- Internal Server Error
Support
Need help with the API?- Check our documentation
- Join our Discord community
- Contact support at [email protected]