Ai

Customgpt

Learn how to use Customgpt with Composio

Overview

SLUG: CUSTOMGPT

Description

CustomGPT.ai is a platform that enables users to create and integrate AI-powered chatbots tailored to their specific data and requirements.

Authentication Details

generic_api_key
stringRequired

Connecting to Customgpt

Create an auth config

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

1

Select App

Navigate to Customgpt.

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 Customgpt 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
4customgpt_auth_config_id = "ac_YOUR_CUSTOMGPT_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": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Customgpt 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, customgpt_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 Customgpt toolkit’s playground

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=["CUSTOMGPT"])
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: Delete CustomGPT Project

Description

Tool to delete a CustomGPT project by ID. Use when you need to permanently remove an existing agent after confirming the ID.

Action Parameters

projectId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete CustomGPT Project License

Description

Tool to delete a CustomGPT project license by ID. Use after confirming both projectId and licenseId; this permanently removes the license.

Action Parameters

licenseId
stringRequired
projectId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Project License

Description

Tool to retrieve a license for a specific project. Use when you need to fetch license details by license ID.

Action Parameters

licenseId
stringRequired
projectId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Project Settings

Description

Tool to retrieve a specific agent's settings. Use when inspecting or auditing an agent's configuration after setup.

Action Parameters

projectId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Usage Limits

Description

Tool to get user's agents, words, and queries usage limits. Use when you need to check current account quotas after authentication.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Current User Profile

Description

Tool to retrieve the current user's profile information. Use when you need to display or verify authenticated user details after login.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Conversation Messages

Description

Tool to list messages in a conversation. Use when you need to retrieve the full chat history after starting a conversation session.

Action Parameters

projectId
stringRequired
sessionId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List CustomGPT Project Licenses

Description

Tool to list all licenses for a CustomGPT project. Use when you have a project ID and want to fetch its license entries.

Action Parameters

projectId
stringRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List CustomGPT Projects

Description

Tool to list all CustomGPT agents. Use when you need to retrieve agent projects with pagination support after setting your API key.

Action Parameters

page
integer

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Update Project License

Description

Tool to update a license's name for a specific project. Use after confirming both projectId and licenseId.

Action Parameters

licenseId
stringRequired
name
stringRequired
projectId
stringRequired

Action Response

data
objectRequired
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Update User Profile

Description

Tool to update the current user's profile. Use after authentication to modify user details such as name, email, or avatar.

Action Parameters

avatarUrl
string
email
string
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired