Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.beam.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Beam AI public API uses API key authentication. Include your API key in the x-api-key header with every request.

​
Base URL

https://api.beamstudio.ai

​
Authentication Header

All API requests require the x-api-key header: 
x-api-key: your-api-key-here
Most endpoints also require a current-workspace-id header: 
current-workspace-id: your-workspace-id

​
Example Authenticated Request

curl -X GET https://api.beamstudio.ai/v2/user/me \
  -H "x-api-key: your-api-key-here" \
  -H "current-workspace-id: your-workspace-id"

​
Getting Your API Key

  1. Log in to Beam AI
  2. Navigate to your workspace settings
  3. Go to the API Keys section
  4. Create a new API key or copy an existing one
Keep your API key secure. Do not share it publicly or commit it to version control.