TsgcHTTP_API_OpenAI › Methods

TsgcHTTP_API_OpenAI Methods

Public methods grouped by purpose, followed by the full alphabetical list.

Chat Completions

Name	Description
CreateChatCompletion	Sends a chat completion request to the OpenAI Chat Completions endpoint and returns the model reply
CreateCompletion	Calls the legacy OpenAI Completions endpoint for prompt-based text generation
CreateEdit	Calls the OpenAI Edits endpoint to apply an instruction-based edit to an input text

Responses

Name	Description
CreateResponse	Creates a new model response using the OpenAI Responses API
RetrieveResponse	Retrieves a previously created response from the OpenAI Responses API by its identifier
DeleteResponse	Deletes a stored response from the OpenAI Responses API
CancelResponse	Cancels a background response that is still in progress on the OpenAI Responses API
ListInputItems	Lists the input items that were provided when a response was created

Images

Name	Description
CreateImage	Generates one or more images from a text prompt using the OpenAI Images endpoint
CreateImageEdit	Edits an existing image using a text prompt and an optional transparency mask
CreateImageVariation	Generates prompt-free variations of an existing image using the OpenAI Images endpoint

Audio

Name	Description
CreateSpeech	Generates audio speech from input text using an OpenAI text-to-speech model
CreateTranscription	Transcribes an audio recording into text using an OpenAI speech-to-text model such as Whisper
CreateTranscriptionFromFile	Transcribes a local audio file into text using an OpenAI speech-to-text model
CreateTranslation	Translates non-English audio into English text using an OpenAI speech model
CreateTranslationFromFile	Translates a local non-English audio file into English text using an OpenAI speech model

Embeddings

Name	Description
CreateEmbeddings	Creates vector embeddings for one or more input strings using an OpenAI embedding model

Moderation

Name	Description
CreateModeration	Classifies text against OpenAI's content policy to detect potentially harmful or unsafe content

Files

Name	Description
UploadFile	Uploads a file to OpenAI for use with assistants, fine-tuning, batch jobs or vision features
ListFiles	Lists all files previously uploaded to the authenticated OpenAI organization
RetrieveFile	Retrieves metadata for a single file previously uploaded to OpenAI
RetrieveFileContent	Downloads the raw content of a file previously uploaded to OpenAI
DeleteFile	Permanently deletes a file previously uploaded to OpenAI

Uploads

Name	Description
CreateUpload	Initiates a multipart upload session for transferring a large file to OpenAI in parts
AddUploadPart	Uploads one part of a previously created multipart upload session
CompleteUpload	Completes a multipart upload by assembling the specified parts into the final file
CancelUpload	Cancels a multipart upload session and discards any parts already transferred

Fine-tuning

Name	Description
CreateFineTuningJob	Starts a new fine-tuning job that customizes a base model on a previously uploaded training file
ListFineTuningJobs	Lists fine-tuning jobs belonging to the authenticated organization with cursor-based pagination
RetrieveFineTuningJob	Retrieves the current state of a fine-tuning job including status and result model name
CancelFineTuningJob	Cancels a running fine-tuning job before it completes training
ListFineTuningJobEvents	Lists status and progress events emitted by a fine-tuning job
ListFineTuningJobCheckpoints	Lists the intermediate model checkpoints produced during a fine-tuning job
CreateFineTune	Creates a fine-tune using the legacy fine-tunes API (deprecated, use CreateFineTuningJob instead)
ListFineTunes	Lists fine-tunes using the legacy fine-tunes API (deprecated, use ListFineTuningJobs instead)
RetrieveFineTune	Retrieves a legacy fine-tune by id (deprecated, use RetrieveFineTuningJob instead)
CancelFineTune	Cancels a legacy fine-tune in progress (deprecated, use CancelFineTuningJob instead)
ListFineTuneEvents	Lists events for a legacy fine-tune (deprecated, use ListFineTuningJobEvents instead)
DeleteFineTuneModel	Deletes a fine-tuned model so it is no longer available for inference

Assistants

Name	Description
CreateAssistant	Creates a new Assistant with model, instructions, tools and metadata
ListAssistants	Returns a paginated list of Assistants belonging to your organization
RetrieveAssistant	Retrieves the full definition of an Assistant by its identifier
ModifyAssistant	Updates an existing Assistant with new model, instructions, tools or metadata
DeleteAssistant	Permanently deletes an Assistant by its identifier

Threads

Name	Description
CreateThread	Creates a new Thread optionally seeded with initial messages and tool resources
RetrieveThread	Retrieves a Thread definition by its identifier
ModifyThread	Updates the tool resources and metadata of an existing Thread
DeleteThread	Permanently deletes a Thread and all of its messages

Messages

Name	Description
CreateMessage	Appends a new message to an existing Thread
ListMessages	Lists messages stored in a Thread with optional Run filtering and pagination
RetrieveMessage	Retrieves a single message from a Thread by its identifier
ModifyMessage	Updates the metadata of an existing message in a Thread
DeleteMessage	Deletes a specific message from a Thread

Runs

Name	Description
CreateRun	Starts a new Run of an Assistant against an existing Thread
ListRuns	Lists Runs executed on a given Thread with pagination support
RetrieveRun	Retrieves the current state of a Run, including status and usage
ModifyRun	Updates the metadata of an existing Run
CancelRun	Cancels an in-progress Run before it completes
SubmitToolOutputsToRun	Returns tool function outputs to a Run that is waiting in requires_action state
ListRunSteps	Lists the execution steps that make up a Run
RetrieveRunSteps	Retrieves a single Run step by its identifier

Vector stores

Name	Description
CreateVectorStore	Creates a new vector store used by the file_search tool
ListVectorStores	Returns a paginated list of vector stores in the current organization
RetrieveVectorStore	Retrieves a vector store by its identifier
ModifyVectorStore	Updates the name, expiration policy or metadata of an existing vector store
DeleteVectorStore	Permanently deletes a vector store and its index
CreateVectorStoreFile	Attaches an uploaded file to a vector store for indexing
ListVectorStoreFiles	Lists files attached to a vector store, optionally filtered by indexing status
RetrieveVectorStoreFile	Retrieves the status of a file attached to a vector store
DeleteVectorStoreFile	Detaches a file from a vector store without deleting the underlying file
CreateVectorStoreFileBatch	Attaches multiple files to a vector store in a single batch operation
RetrieveVectorStoreFileBatch	Retrieves a vector store file batch by its identifier
CancelVectorStoreFileBatch	Cancels a vector store file batch currently in progress
ListVectorStoreFilesBatch	Lists the files that belong to a given vector store file batch

Batches

Name	Description
CreateBatch	Submits a new Batch job for asynchronous bulk inference at reduced cost
RetrieveBatch	Retrieves the current state of a Batch job by its identifier
ListBatches	Returns a paginated list of Batch jobs for the current organization
CancelBatch	Cancels a Batch job that has not yet completed

All Methods (alphabetical)

Name	Description
AddUploadPart	Uploads one part of a previously created multipart upload session
CancelBatch	Cancels a Batch job that has not yet completed
CancelFineTune	Cancels a legacy fine-tune in progress (deprecated, use CancelFineTuningJob instead)
CancelFineTuningJob	Cancels a running fine-tuning job before it completes training
CancelResponse	Cancels a background response that is still in progress on the OpenAI Responses API
CancelRun	Cancels an in-progress Run before it completes
CancelUpload	Cancels a multipart upload session and discards any parts already transferred
CancelVectorStoreFileBatch	Cancels a vector store file batch currently in progress
CompleteUpload	Completes a multipart upload by assembling the specified parts into the final file
CreateAssistant	Creates a new Assistant with model, instructions, tools and metadata
CreateBatch	Submits a new Batch job for asynchronous bulk inference at reduced cost
CreateChatCompletion	Sends a chat completion request to the OpenAI Chat Completions endpoint and returns the model reply
CreateCompletion	Calls the legacy OpenAI Completions endpoint for prompt-based text generation
CreateEdit	Calls the OpenAI Edits endpoint to apply an instruction-based edit to an input text
CreateEmbeddings	Creates vector embeddings for one or more input strings using an OpenAI embedding model
CreateFineTune	Creates a fine-tune using the legacy fine-tunes API (deprecated, use CreateFineTuningJob instead)
CreateFineTuningJob	Starts a new fine-tuning job that customizes a base model on a previously uploaded training file
CreateImage	Generates one or more images from a text prompt using the OpenAI Images endpoint
CreateImageEdit	Edits an existing image using a text prompt and an optional transparency mask
CreateImageVariation	Generates prompt-free variations of an existing image using the OpenAI Images endpoint
CreateMessage	Appends a new message to an existing Thread
CreateModeration	Classifies text against OpenAI's content policy to detect potentially harmful or unsafe content
CreateResponse	Creates a new model response using the OpenAI Responses API
CreateRun	Starts a new Run of an Assistant against an existing Thread
CreateSpeech	Generates audio speech from input text using an OpenAI text-to-speech model
CreateThread	Creates a new Thread optionally seeded with initial messages and tool resources
CreateTranscription	Transcribes an audio recording into text using an OpenAI speech-to-text model such as Whisper
CreateTranscriptionFromFile	Transcribes a local audio file into text using an OpenAI speech-to-text model
CreateTranslation	Translates non-English audio into English text using an OpenAI speech model
CreateTranslationFromFile	Translates a local non-English audio file into English text using an OpenAI speech model
CreateUpload	Initiates a multipart upload session for transferring a large file to OpenAI in parts
CreateVectorStore	Creates a new vector store used by the file_search tool
CreateVectorStoreFile	Attaches an uploaded file to a vector store for indexing
CreateVectorStoreFileBatch	Attaches multiple files to a vector store in a single batch operation
DeleteAssistant	Permanently deletes an Assistant by its identifier
DeleteFile	Permanently deletes a file previously uploaded to OpenAI
DeleteFineTuneModel	Deletes a fine-tuned model so it is no longer available for inference
DeleteMessage	Deletes a specific message from a Thread
DeleteResponse	Deletes a stored response from the OpenAI Responses API
DeleteThread	Permanently deletes a Thread and all of its messages
DeleteVectorStore	Permanently deletes a vector store and its index
DeleteVectorStoreFile	Detaches a file from a vector store without deleting the underlying file
ListAssistants	Returns a paginated list of Assistants belonging to your organization
ListBatches	Returns a paginated list of Batch jobs for the current organization
ListFiles	Lists all files previously uploaded to the authenticated OpenAI organization
ListFineTuneEvents	Lists events for a legacy fine-tune (deprecated, use ListFineTuningJobEvents instead)
ListFineTunes	Lists fine-tunes using the legacy fine-tunes API (deprecated, use ListFineTuningJobs instead)
ListFineTuningJobCheckpoints	Lists the intermediate model checkpoints produced during a fine-tuning job
ListFineTuningJobEvents	Lists status and progress events emitted by a fine-tuning job
ListFineTuningJobs	Lists fine-tuning jobs belonging to the authenticated organization with cursor-based pagination
ListInputItems	Lists the input items that were provided when a response was created
ListMessages	Lists messages stored in a Thread with optional Run filtering and pagination
ListRuns	Lists Runs executed on a given Thread with pagination support
ListRunSteps	Lists the execution steps that make up a Run
ListVectorStoreFiles	Lists files attached to a vector store, optionally filtered by indexing status
ListVectorStoreFilesBatch	Lists the files that belong to a given vector store file batch
ListVectorStores	Returns a paginated list of vector stores in the current organization
ModifyAssistant	Updates an existing Assistant with new model, instructions, tools or metadata
ModifyMessage	Updates the metadata of an existing message in a Thread
ModifyRun	Updates the metadata of an existing Run
ModifyThread	Updates the tool resources and metadata of an existing Thread
ModifyVectorStore	Updates the name, expiration policy or metadata of an existing vector store
RetrieveAssistant	Retrieves the full definition of an Assistant by its identifier
RetrieveBatch	Retrieves the current state of a Batch job by its identifier
RetrieveFile	Retrieves metadata for a single file previously uploaded to OpenAI
RetrieveFileContent	Downloads the raw content of a file previously uploaded to OpenAI
RetrieveFineTune	Retrieves a legacy fine-tune by id (deprecated, use RetrieveFineTuningJob instead)
RetrieveFineTuningJob	Retrieves the current state of a fine-tuning job including status and result model name
RetrieveMessage	Retrieves a single message from a Thread by its identifier
RetrieveResponse	Retrieves a previously created response from the OpenAI Responses API by its identifier
RetrieveRun	Retrieves the current state of a Run, including status and usage
RetrieveRunSteps	Retrieves a single Run step by its identifier
RetrieveThread	Retrieves a Thread definition by its identifier
RetrieveVectorStore	Retrieves a vector store by its identifier
RetrieveVectorStoreFile	Retrieves the status of a file attached to a vector store
RetrieveVectorStoreFileBatch	Retrieves a vector store file batch by its identifier
SubmitToolOutputsToRun	Returns tool function outputs to a Run that is waiting in requires_action state
UploadFile	Uploads a file to OpenAI for use with assistants, fine-tuning, batch jobs or vision features