Brilliant directories

Learn how to use Brilliant directories with Composio

Overview

SLUG: BRILLIANT_DIRECTORIES

Description

Brilliant Directories is an all-in-one platform that enables users to create and manage online membership communities and business directories.

Authentication Details

hostUrl
stringRequired
generic_api_key
stringRequired

Connecting to Brilliant directories

Create an auth config

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

1

Select App

Navigate to [Brilliant directories](https://platform.composio.dev/marketplace/Brilliant directories).

2

Configure Auth Config Settings

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

3

Create and Get auth config ID

Click “Create Brilliant directories 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

1from composio import Composio
2
3# Replace these with your actual values
4brilliant_directories_auth_config_id = "ac_YOUR_BRILLIANT_DIRECTORIES_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def 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 Brilliant directories for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, brilliant_directories_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Brilliant directories toolkit’s playground](https://app.composio.dev/app/Brilliant directories)

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["BRILLIANT_DIRECTORIES"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def 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
33invoke_llm()

Tool List

Tool Name: Create User

Description

This tool creates a new user record in the brilliant directories website database. it supports creating new users with essential details such as email, password, subscriptionid and optional parameters including name, company, contact details, and address information.

Action Parameters

about_me
string
active
integer
address1
string
address2
string
city
string
company
string
country_code
string
email
stringRequired
first_name
string
last_name
string
password
stringRequired
phone_number
string
position
string
state_code
string
subscription_id
integerRequired
verified
integer
website
string
zip_code
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete User

Description

This tool deletes an existing user record from the brilliant directories website database. it allows for the complete removal of a user record and, optionally, the deletion of the member's uploaded images.

Action Parameters

delete_images
integer
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Data Categories

Description

This tool fetches all data categories in a brilliant directories website. data categories are distinct from top categories and represent the various types of data organization within the system.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Lead Fields

Description

This tool retrieves all available fields in the leads table from a brilliant directories website. it returns a json object containing a list of fields and their associated metadata (field name, field type, field label, whether the field is required, and if it is a system field) that can be used to understand the structure and metadata of lead-related fields.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Reviews Fields

Description

This tool retrieves all the available fields in the users reviews table from a brilliant directories website. it is a standalone tool that requires only authentication and provides a comprehensive list of review information such as review text, rating, timestamp, user identification fields, and any custom configured fields in the reviews system.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get User Fields

Description

This tool fetches all available fields from the users data table in your brilliant directories website. it provides a detailed list of available fields for user operations including creation, updating, and retrieval.

Action Parameters

property
stringDefaults to user_id
property_value
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired