Beamer | Composio Docs

Overview

SLUG: BEAMER

Description

Beamer is a platform that enables companies to announce news, updates, and features directly within their applications or websites, enhancing user engagement and communication.

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Beamer

Create an auth config

Use the dashboard to create an auth config for the Beamer toolkit. This allows you to connect multiple Beamer accounts to Composio for agents to use.

Select App

Navigate to Beamer.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Beamer Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 beamer_auth_config_id = "ac_YOUR_BEAMER_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": user_api_key}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Beamer for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, beamer_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Beamer toolkit’s playground

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["BEAMER"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

BEAMER_COUNT_POSTS

Tool Name: Count Posts

Description

Tool to count existing posts. use when you need the number of posts matching specific filters.

Action Parameters

archived

boolean

BEAMER_GET_CATEGORY

Tool Name: Get Category

Description

Tool to retrieve a specific category by its id. use when you need to load metadata for a category before filtering or grouping posts by that category.

Action Parameters

category_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

BEAMER_GET_FEED

Tool Name: Get Feed

Description

Tool to retrieve the url for your standalone feed. use after embedding to fetch the feed link for embedding or sharing.

Action Parameters

filter

string

filterByUrl

boolean

forceFilter

string

ignoreFilters

boolean

language

string

theme

string

userEmail

string

userFirstName

string

userId

string

userLastName

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

BEAMER_GET_FEEDS

Tool Name: Get Feeds

Description

Tool to retrieve the url for your feed. use when you need to embed or access your standalone feed.

Action Parameters

filter

string

filterByUrl

boolean

forceFilter

string

language

string

theme

string

userEmail

string

userFirstName

string

userId

string

userLastName

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

BEAMER_GET_FEED_URL

Tool Name: Get Feed URL

Description

Tool to retrieve the url for your personalized feed. use after setting segmentation or language options to embed or redirect users.

Action Parameters

filter

string

filterByUrl

boolean

forceFilter

string

language

string

theme

string

userEmail

string

userFirstName

string

userId

string

userLastName

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

BEAMER_GET_NOTIFICATION

Tool Name: Get Notification

Description

Tool to retrieve details of a specific notification by its unique notification id. use after obtaining the notification id to fetch its full details.

Action Parameters

notificationId

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

BEAMER_GET_NOTIFICATIONS

Tool Name: Get Notifications

Description

Tool to fetch unread notifications. use after providing user context to retrieve and mark notifications as read.

Action Parameters

BEAMER_GET_POSTS

Tool Name: Get Posts

Description

Tool to retrieve a list of posts. use when you need ids and titles of posts for further operations.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

BEAMER_GET_POST_COMMENTS

Tool Name: Get Post Comments

Description

Tool to retrieve comments for a specific post. use after identifying the post id to list its comments.

Action Parameters

dateFrom

string

dateTo

string

language

string

maxResults

integer

page

integer

postId

integerRequired

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

BEAMER_GET_POST_REACTIONS

Tool Name: Get Post Reactions

Description

Tool to retrieve all reactions associated with a specific post. use when you need to list reactions and optionally filter by date, reaction type, or pagination.

Action Parameters

dateFrom

string

dateTo

string

maxResults

integer

page

integer

postId

integerRequired

reaction

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

BEAMER_PING

Tool Name: Ping API

Description

Tool to ping the beamer api. use when verifying api key authentication before making further requests.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired