api.md

Shared

Types:

• FunctionDefinition
• FunctionParameters

Completions

Types:

• Completion
• CompletionChoice
• CompletionUsage

Methods:

• client.completions.create({ ...params }) -> Completion

Chat

Completions

Types:

• ChatCompletion
• ChatCompletionAssistantMessageParam
• ChatCompletionChunk
• ChatCompletionContentPart
• ChatCompletionContentPartImage
• ChatCompletionContentPartText
• ChatCompletionFunctionCallOption
• ChatCompletionFunctionMessageParam
• ChatCompletionMessage
• ChatCompletionMessageParam
• ChatCompletionMessageToolCall
• ChatCompletionNamedToolChoice
• ChatCompletionRole
• ChatCompletionSystemMessageParam
• ChatCompletionTool
• ChatCompletionToolChoiceOption
• ChatCompletionToolMessageParam
• ChatCompletionUserMessageParam
• CreateChatCompletionRequestMessage

Methods:

• client.chat.completions.create({ ...params }) -> ChatCompletion

Edits

Types:

• Edit

Methods:

• client.edits.create({ ...params }) -> Edit

Embeddings

Types:

• CreateEmbeddingResponse
• Embedding

Methods:

• client.embeddings.create({ ...params }) -> CreateEmbeddingResponse

Files

Types:

• FileContent
• FileDeleted
• FileObject

Methods:

• client.files.create({ ...params }) -> FileObject
• client.files.retrieve(fileId) -> FileObject
• client.files.list({ ...params }) -> FileObjectsPage
• client.files.del(fileId) -> FileDeleted
• client.files.content(fileId) -> Response
• client.files.retrieveContent(fileId) -> string
• client.files.waitForProcessing(id, { pollInterval = 5000, maxWait = 30 _ 60 _ 1000 }) -> Promise<FileObject>

Images

Types:

• Image
• ImagesResponse

Methods:

• client.images.createVariation({ ...params }) -> ImagesResponse
• client.images.edit({ ...params }) -> ImagesResponse
• client.images.generate({ ...params }) -> ImagesResponse

Audio

Transcriptions

Types:

• Transcription

Methods:

• client.audio.transcriptions.create({ ...params }) -> Transcription

Translations

Types:

• Translation

Methods:

• client.audio.translations.create({ ...params }) -> Translation

Speech

Methods:

• client.audio.speech.create({ ...params }) -> Response

Moderations

Types:

• Moderation
• ModerationCreateResponse

Methods:

• client.moderations.create({ ...params }) -> ModerationCreateResponse

Models

Types:

• Model
• ModelDeleted

Methods:

• client.models.retrieve(model) -> Model
• client.models.list() -> ModelsPage
• client.models.del(model) -> ModelDeleted

FineTuning

Jobs

Types:

• FineTuningJob
• FineTuningJobEvent

Methods:

• client.fineTuning.jobs.create({ ...params }) -> FineTuningJob
• client.fineTuning.jobs.retrieve(fineTuningJobId) -> FineTuningJob
• client.fineTuning.jobs.list({ ...params }) -> FineTuningJobsPage
• client.fineTuning.jobs.cancel(fineTuningJobId) -> FineTuningJob
• client.fineTuning.jobs.listEvents(fineTuningJobId, { ...params }) -> FineTuningJobEventsPage

FineTunes

Types:

• FineTune
• FineTuneEvent
• FineTuneEventsListResponse

Methods:

• client.fineTunes.create({ ...params }) -> FineTune
• client.fineTunes.retrieve(fineTuneId) -> FineTune
• client.fineTunes.list() -> FineTunesPage
• client.fineTunes.cancel(fineTuneId) -> FineTune
• client.fineTunes.listEvents(fineTuneId, { ...params }) -> FineTuneEventsListResponse

Beta

Chat

Completions

Methods:

• client.beta.chat.completions.runFunctions(body, options?) -> ChatCompletionRunner | ChatCompletionStreamingRunner
• client.beta.chat.completions.runTools(body, options?) -> ChatCompletionRunner | ChatCompletionStreamingRunner
• client.beta.chat.completions.stream(body, options?) -> ChatCompletionStream

Assistants

Types:

• Assistant
• AssistantDeleted

Methods:

• client.beta.assistants.create({ ...params }) -> Assistant
• client.beta.assistants.retrieve(assistantId) -> Assistant
• client.beta.assistants.update(assistantId, { ...params }) -> Assistant
• client.beta.assistants.list({ ...params }) -> AssistantsPage
• client.beta.assistants.del(assistantId) -> AssistantDeleted

Files

Types:

• AssistantFile
• FileDeleteResponse

Methods:

• client.beta.assistants.files.create(assistantId, { ...params }) -> AssistantFile
• client.beta.assistants.files.retrieve(assistantId, fileId) -> AssistantFile
• client.beta.assistants.files.list(assistantId, { ...params }) -> AssistantFilesPage
• client.beta.assistants.files.del(assistantId, fileId) -> FileDeleteResponse

Threads

Types:

• Thread
• ThreadDeleted

Methods:

• client.beta.threads.create({ ...params }) -> Thread
• client.beta.threads.retrieve(threadId) -> Thread
• client.beta.threads.update(threadId, { ...params }) -> Thread
• client.beta.threads.del(threadId) -> ThreadDeleted
• client.beta.threads.createAndRun({ ...params }) -> Run

Runs

Types:

• RequiredActionFunctionToolCall
• Run

Methods:

• client.beta.threads.runs.create(threadId, { ...params }) -> Run
• client.beta.threads.runs.retrieve(threadId, runId) -> Run
• client.beta.threads.runs.update(threadId, runId, { ...params }) -> Run
• client.beta.threads.runs.list(threadId, { ...params }) -> RunsPage
• client.beta.threads.runs.cancel(threadId, runId) -> Run
• client.beta.threads.runs.submitToolOutputs(threadId, runId, { ...params }) -> Run

Steps

Types:

• CodeToolCall
• FunctionToolCall
• MessageCreationStepDetails
• RetrievalToolCall
• RunStep
• ToolCallsStepDetails

Methods:

• client.beta.threads.runs.steps.retrieve(threadId, runId, stepId) -> RunStep
• client.beta.threads.runs.steps.list(threadId, runId, { ...params }) -> RunStepsPage

Messages

Types:

• MessageContentImageFile
• MessageContentText
• ThreadMessage
• ThreadMessageDeleted

Methods:

• client.beta.threads.messages.create(threadId, { ...params }) -> ThreadMessage
• client.beta.threads.messages.retrieve(threadId, messageId) -> ThreadMessage
• client.beta.threads.messages.update(threadId, messageId, { ...params }) -> ThreadMessage
• client.beta.threads.messages.list(threadId, { ...params }) -> ThreadMessagesPage

Files

Types:

• MessageFile

Methods:

• client.beta.threads.messages.files.retrieve(threadId, messageId, fileId) -> MessageFile
• client.beta.threads.messages.files.list(threadId, messageId, { ...params }) -> MessageFilesPage