Skip to main content
Every openai.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.

Assistants

create

assistants.create Create an assistant Risk: write
Input
Output

delete

assistants.delete Delete an assistant Risk: destructive
Input Output

list

assistants.list List assistants Risk: read
Input Output

modify

assistants.modify Modify an assistant Risk: write
Input
Output

retrieve

assistants.retrieve Retrieve an assistant by id Risk: read
Input Output

Audio

createSpeech

audio.createSpeech Generate spoken audio from text Risk: write
Input Output

createTranscription

audio.createTranscription Transcribe audio into text Risk: write
Input Output

createTranslation

audio.createTranslation Translate audio into English text Risk: write
Input Output

Batches

cancel

batches.cancel Cancel an in-progress batch job Risk: destructive
Input Output

create

batches.create Create a batch job Risk: write
Input
Output

list

batches.list List batch jobs Risk: read
Input Output

retrieve

batches.retrieve Retrieve a batch job Risk: read
Input Output

Chat

createCompletion

chat.createCompletion Create a chat completion for the given messages Risk: write
Input
Output

Chat Completions

delete

chatCompletions.delete Delete a stored chat completion Risk: destructive
Input Output

list

chatCompletions.list List stored chat completions Risk: read
Input
Output

listMessages

chatCompletions.listMessages List messages of a stored chat completion Risk: read
Input Output

retrieve

chatCompletions.retrieve Retrieve a stored chat completion Risk: read
Input Output

update

chatCompletions.update Update a stored chat completion’s metadata Risk: write
Input
Output

Chatkit

getThread

chatkit.getThread Retrieve a ChatKit thread Risk: read
Input Output

listThreadItems

chatkit.listThreadItems List items in a ChatKit thread Risk: read
Input Output

listThreads

chatkit.listThreads List ChatKit threads Risk: read
Input Output

Completions

create

completions.create Create a legacy text completion Risk: write
Input
Output

Container Files

create

containerFiles.create Add a file to a container Risk: write
Input Output

delete

containerFiles.delete Delete a container file Risk: destructive
Input Output

list

containerFiles.list List files in a container Risk: read
Input Output

retrieve

containerFiles.retrieve Retrieve a container file Risk: read
Input Output

retrieveContent

containerFiles.retrieveContent Download the contents of a container file Risk: read
Input Output

Containers

create

containers.create Create a code interpreter container Risk: write
Input
Output

delete

containers.delete Delete a container Risk: destructive
Input Output

list

containers.list List containers Risk: read
Input Output

retrieve

containers.retrieve Retrieve a container Risk: read
Input Output

Conversations

create

conversations.create Create a conversation Risk: write
Input
Output

createItems

conversations.createItems Add items to a conversation Risk: write
Input
Output

delete

conversations.delete Delete a conversation Risk: destructive
Input Output

deleteItem

conversations.deleteItem Delete a conversation item Risk: destructive
Input Output

getItem

conversations.getItem Retrieve a conversation item Risk: read
Input Output

listItems

conversations.listItems List items in a conversation Risk: read
Input Output

update

conversations.update Update a conversation’s metadata Risk: write
Input
Output

Embeddings

create

embeddings.create Create embeddings for the given input Risk: write
Input Output

Engines

list

engines.list List available engines (legacy, deprecated) Risk: read
Input: empty object Output

retrieve

engines.retrieve Retrieve an engine by id (legacy, deprecated) Risk: read
Input Output

Eval Runs

cancel

evalRuns.cancel Cancel an in-progress eval run Risk: destructive
Input Output

create

evalRuns.create Create an eval run Risk: write
Input
Output

delete

evalRuns.delete Delete an eval run Risk: destructive
Input Output

get

evalRuns.get Retrieve an eval run Risk: read
Input Output

getOutputItem

evalRuns.getOutputItem Retrieve an eval run output item Risk: read
Input Output

list

evalRuns.list List eval runs Risk: read
Input Output

listOutputItems

evalRuns.listOutputItems List output items for an eval run Risk: read
Input Output

Evals

create

evals.create Create an eval Risk: write
Input
Output

delete

evals.delete Delete an eval Risk: destructive
Input Output

get

evals.get Retrieve an eval Risk: read
Input Output

list

evals.list List evals Risk: read
Input Output

update

evals.update Update an eval Risk: write
Input
Output

Files

delete

files.delete Delete a file Risk: destructive
Input Output

downloadContent

files.downloadContent Download the contents of a file Risk: read
Input Output

list

files.list List uploaded files Risk: read
Input Output

retrieve

files.retrieve Retrieve file metadata Risk: read
Input Output

upload

files.upload Upload a file to OpenAI Risk: write
Input Output

Fine Tuning

cancelJob

fineTuning.cancelJob Cancel an in-progress fine-tuning job Risk: destructive
Input Output

createJob

fineTuning.createJob Create a fine-tuning job Risk: write
Input
Output

listCheckpoints

fineTuning.listCheckpoints List checkpoints for a fine-tuning job Risk: read
Input Output

listEvents

fineTuning.listEvents List events for a fine-tuning job Risk: read
Input Output

listJobs

fineTuning.listJobs List fine-tuning jobs Risk: read
Input
Output

retrieveJob

fineTuning.retrieveJob Retrieve a fine-tuning job Risk: read
Input Output

Graders

run

graders.run Run a grader against a model sample Risk: read
Input
Output

validate

graders.validate Validate a grader configuration Risk: read
Input
Output

Images

create

images.create Generate images from a prompt Risk: write
Input Output

createEdit

images.createEdit Edit an image given a prompt and mask Risk: write
Input Output

createVariation

images.createVariation Create variations of an image Risk: write
Input Output

Messages

create

messages.create Create a message on a thread Risk: write
Input
Output

delete

messages.delete Delete a message Risk: destructive
Input Output

list

messages.list List messages on a thread Risk: read
Input Output

modify

messages.modify Modify a message Risk: write
Input
Output

retrieve

messages.retrieve Retrieve a message Risk: read
Input Output

Models

list

models.list List available models Risk: read
Input: empty object Output

retrieve

models.retrieve Retrieve a model by id Risk: read
Input Output

Moderation

create

moderation.create Classify text/image input against usage policies Risk: read
Input
Output

Realtime

createCall

realtime.createCall Create a realtime call Risk: write
Input
Output

createClientSecret

realtime.createClientSecret Create an ephemeral client secret for the Realtime API Risk: write
Input
Output

createSession

realtime.createSession Create a realtime session Risk: write
Input Output

createTranscriptionSession

realtime.createTranscriptionSession Create a realtime transcription session Risk: write
Input
Output

Responses

cancel

responses.cancel Cancel an in-progress background response Risk: destructive
Input Output

compact

responses.compact Compact response input to reduce token usage Risk: write
Input
Output

create

responses.create Create a model response via the Responses API Risk: write
Input
Output

delete

responses.delete Delete a stored model response Risk: destructive
Input Output

listInputItems

responses.listInputItems List input items for a response Risk: read
Input Output

retrieve

responses.retrieve Retrieve a model response Risk: read
Input Output

Runs

cancel

runs.cancel Cancel an in-progress run Risk: destructive
Input Output

create

runs.create Create a run on a thread Risk: write
Input
Output

list

runs.list List runs on a thread Risk: read
Input Output

modify

runs.modify Modify a run Risk: write
Input
Output

retrieve

runs.retrieve Retrieve a run Risk: read
Input Output

submitToolOutputs

runs.submitToolOutputs Submit tool outputs to a run awaiting action Risk: write
Input
Output

Run Steps

list

runSteps.list List steps of a run Risk: read
Input Output

retrieve

runSteps.retrieve Retrieve a run step Risk: read
Input Output

Skills

create

skills.create Upload a skill Risk: write
Input Output

delete

skills.delete Delete a skill Risk: destructive
Input Output

list

skills.list List skills Risk: read
Input Output

Threads

create

threads.create Create a thread Risk: write
Input
Output

createAndRun

threads.createAndRun Create a thread and run it in one call Risk: write
Input
Output

delete

threads.delete Delete a thread Risk: destructive
Input Output

modify

threads.modify Modify a thread Risk: write
Input
Output

retrieve

threads.retrieve Retrieve a thread by id Risk: read
Input Output

Tokens

countInput

tokens.countInput Count input tokens for a prospective request Risk: read
Input
Output

Uploads

addPart

uploads.addPart Add a part of file data to an upload Risk: write
Input Output

cancel

uploads.cancel Cancel an in-progress upload session Risk: destructive
Input Output

complete

uploads.complete Complete a multipart upload session Risk: write
Input Output

create

uploads.create Create a multipart upload session Risk: write
Input Output

Vector Store File Batches

create

vectorStoreFileBatches.create Attach a batch of files to a vector store Risk: write
Input
Output

listFiles

vectorStoreFileBatches.listFiles List files in a vector store file batch Risk: read
Input Output

retrieve

vectorStoreFileBatches.retrieve Retrieve a vector store file batch Risk: read
Input Output

Vector Store Files

create

vectorStoreFiles.create Attach a file to a vector store Risk: write
Input
Output

delete

vectorStoreFiles.delete Detach a file from a vector store Risk: destructive
Input Output

list

vectorStoreFiles.list List files attached to a vector store Risk: read
Input Output

retrieve

vectorStoreFiles.retrieve Retrieve a vector store file Risk: read
Input Output

retrieveContent

vectorStoreFiles.retrieveContent Retrieve the parsed content of a vector store file Risk: read
Input Output

updateAttributes

vectorStoreFiles.updateAttributes Update attributes on a vector store file Risk: write
Input
Output

Vector Stores

create

vectorStores.create Create a vector store Risk: write
Input
Output

delete

vectorStores.delete Delete a vector store Risk: destructive
Input Output

list

vectorStores.list List vector stores Risk: read
Input Output

modify

vectorStores.modify Modify a vector store Risk: write
Input
Output

retrieve

vectorStores.retrieve Retrieve a vector store Risk: read
Input Output

vectorStores.search Search a vector store for relevant chunks Risk: read
Input
Output

Videos

create

videos.create Generate a video from a prompt Risk: write
Input Output

createRemix

videos.createRemix Create a remix of an existing video Risk: write
Input Output

delete

videos.delete Delete a video Risk: destructive
Input Output

download

videos.download Download the rendered content of a video Risk: read
Input Output

list

videos.list List generated videos Risk: read
Input Output

retrieve

videos.retrieve Retrieve a video Risk: read
Input Output