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

Tools

SLUG: OPENAI_CREATE_ASSISTANT

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

SLUG: OPENAI_CREATE_MESSAGE

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

SLUG: OPENAI_CREATE_THREAD

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

SLUG: OPENAI_DELETE_ASSISTANT

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

SLUG: OPENAI_DELETE_FILE

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

SLUG: OPENAI_LIST_FILES

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

SLUG: OPENAI_LIST_FINE_TUNES

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

SLUG: OPENAI_LIST_MODELS

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

SLUG: OPENAI_LIST_RUN_STEPS

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

SLUG: OPENAI_MODIFY_THREAD

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

SLUG: OPENAI_RETRIEVE_ASSISTANT

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

SLUG: OPENAI_RETRIEVE_MODEL

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

SLUG: OPENAI_RETRIEVE_THREAD

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

SLUG: OPENAI_UPLOAD_FILE

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