Beam Api

Start Task

Initiates a task on Beam API agent and returns an updatesUrl (SSE) for realtime task updates

Listen Task

Polls the AgentTask until it reaches a terminal status, returning a stitched summary. Returns done:false if time window elapses.

Get Current User

Retrieve the profile information of the currently authenticated user, including their workspaces and permissions.

List Agents

Retrieve a paginated list of agents available in your workspace. Filter by type, category, or search query.

Download Context File

Generate a download link for an agent context file.

Test Graph Node

Test a specific node in the agent graph to validate its configuration and behavior.

Get Agent Graph

Retrieve the workflow graph configuration for a specific agent.

Get Task Nodes By Tool

Retrieve task nodes that use a specific tool function for analysis and optimization.

Update Graph Node

Update a specific node in an agent graph with new configuration, properties, and behavior settings. This allows you to modify node parameters such as position, objectives, error handling, retry logic, evaluation criteria, and tool configurations. The node must exist within the specified agent graph, and you must have appropriate permissions to modify it.

Create Agent Task

Create a new task for an agent to execute. The task will be queued and processed according to the agent workflow.

List Agent Tasks

Retrieve a paginated list of agent tasks with filtering and grouping options.

Get Task Details

Retrieve detailed information about a specific task including execution status and results.

Get Agent Analytics

Retrieve analytics data for agent task execution including success rates, performance metrics, and usage statistics.

Submit User Input

Provide user input for a task that requires human interaction to continue execution.

Reject Task Execution

Reject a task execution that requires user consent. The task will be marked as rejected and stop execution.

Approve Task Execution

Provide user consent for a task to continue execution when approval is required.

Get Latest Executions

Retrieve the most recent task executions for monitoring and debugging purposes.

Get Next Task

Iterate through tasks based on filters. Useful for task queue processing and navigation.

Rate Task Output

Submit a rating for task execution output to improve agent performance.

Retry Task Execution

Retry a failed or incomplete task execution with optional modifications.

Get Tool Output Schema

Retrieve the expected output schema for a specific tool in the agent graph.