Artificial Intelligence

Openai

Learn how to use Openai with Composio

Overview

SLUG: OPENAI

Description

OpenAI is a leading AI research and deployment company that develops advanced artificial intelligence models, including GPT and DALL·E, aiming to create safe and beneficial AI to solve real-world problems and enhance human productivity.

Authentication Details

generic_api_key
stringRequired
organization_id
string

Connecting to Openai

Create an auth config

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

1

Select App

Navigate to Openai.

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 Openai 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
4openai_auth_config_id = "ac_YOUR_OPENAI_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 Openai 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, openai_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 Openai 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=["OPENAI"])
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 Assistant

Description

Tool to create a new assistant with specified parameters. use after finalizing model, tools, and instructions.

Action Parameters

description
string
file_ids
array
instructions
string
metadata
object
model
stringRequired
name
string
tools
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Message

Description

Tool to create a new message in a specific thread. use when adding messages to an existing conversation after confirming the thread id.

Action Parameters

attachments
array
content
stringRequired
metadata
object
role
stringRequired
thread_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Thread

Description

Tool to create a new thread. use when initializing a conversation with optional starter messages.

Action Parameters

messages
array
metadata
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete assistant

Description

Tool to delete a specific assistant by its id. use when you need to remove an assistant after confirming its id.

Action Parameters

assistant_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete file

Description

Tool to delete a file. use when you need to remove an uploaded file by its id after confirming the target.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List files

Description

Tool to retrieve a list of files. use when you need to view all files uploaded to your organization.

Action Parameters

limit
integer

Action Response

data
arrayRequired
error
string
object
stringRequired
successful
booleanRequired

Tool Name: List fine-tunes

Description

Tool to list your organization's fine-tuning jobs. use when you need to review all fine-tune runs.

Action Parameters

Action Response

data
arrayRequired
error
string
object
stringRequired
successful
booleanRequired

Tool Name: List models

Description

Tool to list available models. use when you need to discover which models you can call. use after confirming your api key is valid.

Action Parameters

Action Response

data
arrayRequired
error
string
object
stringRequired
successful
booleanRequired

Tool Name: List run steps

Description

Tool to retrieve all steps of a specific run. use when you need to inspect each step's details after initiating a run.

Action Parameters

after
string
before
string
include[]
array
limit
integer
order
string
run_id
stringRequired
thread_id
stringRequired

Action Response

data
arrayRequired
error
string
first_id
stringRequired
has_more
booleanRequired
last_id
stringRequired
object
stringRequired
successful
booleanRequired

Tool Name: Modify thread

Description

Tool to modify an existing thread's metadata. use after obtaining the thread id when you need to update metadata.

Action Parameters

metadata
object
thread_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve assistant

Description

Tool to retrieve details of a specific assistant. use when you need to confirm assistant metadata before performing further operations.

Action Parameters

assistant_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve model

Description

Tool to retrieve details of a specific model. use when you have a model id and need to confirm its metadata before using it.

Action Parameters

model
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve thread

Description

Tool to retrieve details of a specific thread by its id. use when you need to fetch thread metadata before listing messages.

Action Parameters

thread_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Upload file

Description

Tool to upload a file for use across openai endpoints. use before referencing the file in tasks like fine-tuning.

Action Parameters

file
stringRequired
purpose
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired