Skip to main content
Once your agent is tested and ready, publish it to make it available for production use via the Beam platform or API.

​
Publishing Your Agent

1

Test Your Agent

Run your agent with test inputs to verify all nodes execute correctly and outputs match expectations.
2

Publish

Click Publish in the agent builder to make your agent available for production use.Published agents can be:
  • Triggered via the Beam platform
  • Called through the API
  • Embedded in external applications
3

Get API Access

Navigate to Settings → API Keys to generate credentials for programmatic access.
API key generation

​
Using the API

​
Authentication

All API requests require an API key. Include your API key in request headers: 
x-api-key: YOUR_API_KEY
current-workspace-id: YOUR_WORKSPACE_ID

​
Trigger Agent Task

POST https://api.beamstudio.ai/agent-task
Content-Type: application/json

{
  "agent_id": "your-agent-id",
  "task_query": "Process this customer inquiry",
  "variables": {
    "customer_email": "user@example.com",
    "priority": "high"
  }
}

​
Get Task Status

GET https://api.beamstudio.ai/agent-task/{task_id}

​
Deployment Best Practices

Version Control:
  • Test changes in a duplicate agent before updating production
  • Keep notes on configuration changes
  • Maintain rollback versions for critical agents
Monitoring:
  • Review task execution logs regularly
  • Set up alerts for failed tasks
  • Track performance metrics and execution times
Security:
  • Rotate API keys periodically
  • Use workspace-specific keys for different environments
  • Never expose API keys in client-side code
  • Restrict API key permissions to minimum required
Scaling:
  • Monitor task volume and execution patterns
  • Optimize long-running workflows
  • Cache frequently accessed data
  • Use batch operations where possible

​
API Documentation

For complete API reference, authentication details, and endpoint documentation, see the API Reference.

​
Next Steps

API Reference

Complete API documentation and endpoints

Multi-Agent Collaboration

Coordinate multiple agents in production

Triggers & Webhooks

Automate agent execution with triggers and webhooks

Task Executions

Monitor and track production tasks