api.md

Shared Params Types

• shared.FunctionDefinitionParam
• shared.FunctionParameters
• shared.ResponseFormatJSONObjectParam
• shared.ResponseFormatJSONSchemaParam
• shared.ResponseFormatTextParam

Shared Response Types

• shared.ErrorObject
• shared.FunctionDefinition
• shared.FunctionParameters

Completions

Response Types:

• openai.Completion
• openai.CompletionChoice
• openai.CompletionUsage

Methods:

• client.Completions.New(ctx context.Context, body openai.CompletionNewParams) (openai.Completion, error)

Chat

Params Types:

• openai.ChatModel

Completions

Params Types:

• openai.ChatCompletionAssistantMessageParam
• openai.ChatCompletionAudioParam
• openai.ChatCompletionContentPartUnionParam
• openai.ChatCompletionContentPartImageParam
• openai.ChatCompletionContentPartInputAudioParam
• openai.ChatCompletionContentPartRefusalParam
• openai.ChatCompletionContentPartTextParam
• openai.ChatCompletionFunctionCallOptionParam
• openai.ChatCompletionFunctionMessageParam
• openai.ChatCompletionMessageParamUnion
• openai.ChatCompletionMessageToolCallParam
• openai.ChatCompletionModality
• openai.ChatCompletionNamedToolChoiceParam
• openai.ChatCompletionStreamOptionsParam
• openai.ChatCompletionSystemMessageParam
• openai.ChatCompletionToolParam
• openai.ChatCompletionToolChoiceOptionUnionParam
• openai.ChatCompletionToolMessageParam
• openai.ChatCompletionUserMessageParam

Response Types:

• openai.ChatCompletion
• openai.ChatCompletionAudio
• openai.ChatCompletionChunk
• openai.ChatCompletionMessage
• openai.ChatCompletionMessageToolCall
• openai.ChatCompletionTokenLogprob

Methods:

• client.Chat.Completions.New(ctx context.Context, body openai.ChatCompletionNewParams) (openai.ChatCompletion, error)

Embeddings

Params Types:

• openai.EmbeddingModel

Response Types:

• openai.CreateEmbeddingResponse
• openai.Embedding

Methods:

• client.Embeddings.New(ctx context.Context, body openai.EmbeddingNewParams) (openai.CreateEmbeddingResponse, error)

Files

Params Types:

• openai.FilePurpose

Response Types:

• openai.FileDeleted
• openai.FileObject

Methods:

• client.Files.New(ctx context.Context, body openai.FileNewParams) (openai.FileObject, error)
• client.Files.Get(ctx context.Context, fileID string) (openai.FileObject, error)
• client.Files.List(ctx context.Context, query openai.FileListParams) (pagination.Page[openai.FileObject], error)
• client.Files.Delete(ctx context.Context, fileID string) (openai.FileDeleted, error)
• client.Files.Content(ctx context.Context, fileID string) (http.Response, error)

Images

Params Types:

• openai.ImageModel

Response Types:

• openai.Image
• openai.ImagesResponse

Methods:

• client.Images.NewVariation(ctx context.Context, body openai.ImageNewVariationParams) (openai.ImagesResponse, error)
• client.Images.Edit(ctx context.Context, body openai.ImageEditParams) (openai.ImagesResponse, error)
• client.Images.Generate(ctx context.Context, body openai.ImageGenerateParams) (openai.ImagesResponse, error)

Audio

Params Types:

• openai.AudioModel
• openai.AudioResponseFormat

Transcriptions

Response Types:

• openai.Transcription

Methods:

• client.Audio.Transcriptions.New(ctx context.Context, body openai.AudioTranscriptionNewParams) (Transcription, error)

Translations

Response Types:

• openai.Translation

Methods:

• client.Audio.Translations.New(ctx context.Context, body openai.AudioTranslationNewParams) (Translation, error)

Speech

Params Types:

• openai.SpeechModel

Methods:

• client.Audio.Speech.New(ctx context.Context, body openai.AudioSpeechNewParams) (http.Response, error)

Moderations

Params Types:

• openai.ModerationImageURLInputParam
• openai.ModerationModel
• openai.ModerationMultiModalInputUnionParam
• openai.ModerationTextInputParam

Response Types:

• openai.Moderation
• openai.ModerationNewResponse

Methods:

• client.Moderations.New(ctx context.Context, body openai.ModerationNewParams) (openai.ModerationNewResponse, error)

Models

Response Types:

• openai.Model
• openai.ModelDeleted

Methods:

• client.Models.Get(ctx context.Context, model string) (openai.Model, error)
• client.Models.List(ctx context.Context) (pagination.Page[openai.Model], error)
• client.Models.Delete(ctx context.Context, model string) (openai.ModelDeleted, error)

FineTuning

Jobs

Response Types:

• openai.FineTuningJob
• openai.FineTuningJobEvent
• openai.FineTuningJobWandbIntegration
• openai.FineTuningJobWandbIntegrationObject

Methods:

• client.FineTuning.Jobs.New(ctx context.Context, body openai.FineTuningJobNewParams) (openai.FineTuningJob, error)
• client.FineTuning.Jobs.Get(ctx context.Context, fineTuningJobID string) (openai.FineTuningJob, error)
• client.FineTuning.Jobs.List(ctx context.Context, query openai.FineTuningJobListParams) (pagination.CursorPage[openai.FineTuningJob], error)
• client.FineTuning.Jobs.Cancel(ctx context.Context, fineTuningJobID string) (openai.FineTuningJob, error)
• client.FineTuning.Jobs.ListEvents(ctx context.Context, fineTuningJobID string, query openai.FineTuningJobListEventsParams) (pagination.CursorPage[openai.FineTuningJobEvent], error)

Checkpoints

Response Types:

• openai.FineTuningJobCheckpoint

Methods:

• client.FineTuning.Jobs.Checkpoints.List(ctx context.Context, fineTuningJobID string, query openai.FineTuningJobCheckpointListParams) (pagination.CursorPage[openai.FineTuningJobCheckpoint], error)

Beta

VectorStores

Params Types:

• openai.AutoFileChunkingStrategyParam
• openai.FileChunkingStrategyParamUnion
• openai.StaticFileChunkingStrategyParam
• openai.StaticFileChunkingStrategyParam

Response Types:

• openai.FileChunkingStrategy
• openai.OtherFileChunkingStrategyObject
• openai.StaticFileChunkingStrategy
• openai.StaticFileChunkingStrategyObject
• openai.VectorStore
• openai.VectorStoreDeleted

Methods:

• client.Beta.VectorStores.New(ctx context.Context, body openai.BetaVectorStoreNewParams) (openai.VectorStore, error)
• client.Beta.VectorStores.Get(ctx context.Context, vectorStoreID string) (openai.VectorStore, error)
• client.Beta.VectorStores.Update(ctx context.Context, vectorStoreID string, body openai.BetaVectorStoreUpdateParams) (openai.VectorStore, error)
• client.Beta.VectorStores.List(ctx context.Context, query openai.BetaVectorStoreListParams) (pagination.CursorPage[openai.VectorStore], error)
• client.Beta.VectorStores.Delete(ctx context.Context, vectorStoreID string) (openai.VectorStoreDeleted, error)

Files

Response Types:

• openai.VectorStoreFile
• openai.VectorStoreFileDeleted

Methods:

• client.Beta.VectorStores.Files.New(ctx context.Context, vectorStoreID string, body openai.BetaVectorStoreFileNewParams) (openai.VectorStoreFile, error)
• client.Beta.VectorStores.Files.Get(ctx context.Context, vectorStoreID string, fileID string) (openai.VectorStoreFile, error)
• client.Beta.VectorStores.Files.List(ctx context.Context, vectorStoreID string, query openai.BetaVectorStoreFileListParams) (pagination.CursorPage[openai.VectorStoreFile], error)
• client.Beta.VectorStores.Files.Delete(ctx context.Context, vectorStoreID string, fileID string) (openai.VectorStoreFileDeleted, error)

FileBatches

Response Types:

• openai.VectorStoreFileBatch

Methods:

• client.Beta.VectorStores.FileBatches.New(ctx context.Context, vectorStoreID string, body openai.BetaVectorStoreFileBatchNewParams) (openai.VectorStoreFileBatch, error)
• client.Beta.VectorStores.FileBatches.Get(ctx context.Context, vectorStoreID string, batchID string) (openai.VectorStoreFileBatch, error)
• client.Beta.VectorStores.FileBatches.Cancel(ctx context.Context, vectorStoreID string, batchID string) (openai.VectorStoreFileBatch, error)
• client.Beta.VectorStores.FileBatches.ListFiles(ctx context.Context, vectorStoreID string, batchID string, query openai.BetaVectorStoreFileBatchListFilesParams) (pagination.CursorPage[openai.VectorStoreFile], error)

Assistants

Params Types:

• openai.AssistantToolUnionParam
• openai.CodeInterpreterToolParam
• openai.FileSearchToolParam
• openai.FunctionToolParam

Response Types:

• openai.Assistant
• openai.AssistantDeleted
• openai.AssistantStreamEvent
• openai.AssistantTool
• openai.CodeInterpreterTool
• openai.FileSearchTool
• openai.FunctionTool

Methods:

• client.Beta.Assistants.New(ctx context.Context, body openai.BetaAssistantNewParams) (openai.Assistant, error)
• client.Beta.Assistants.Get(ctx context.Context, assistantID string) (openai.Assistant, error)
• client.Beta.Assistants.Update(ctx context.Context, assistantID string, body openai.BetaAssistantUpdateParams) (openai.Assistant, error)
• client.Beta.Assistants.List(ctx context.Context, query openai.BetaAssistantListParams) (pagination.CursorPage[openai.Assistant], error)
• client.Beta.Assistants.Delete(ctx context.Context, assistantID string) (openai.AssistantDeleted, error)

Threads

Params Types:

• openai.AssistantToolChoiceParam
• openai.AssistantToolChoiceFunctionParam
• openai.AssistantToolChoiceOptionUnionParam

Response Types:

• openai.AssistantToolChoice
• openai.AssistantToolChoiceFunction
• openai.AssistantToolChoiceOptionUnion
• openai.Thread
• openai.ThreadDeleted

Methods:

• client.Beta.Threads.New(ctx context.Context, body openai.BetaThreadNewParams) (openai.Thread, error)
• client.Beta.Threads.Get(ctx context.Context, threadID string) (openai.Thread, error)
• client.Beta.Threads.Update(ctx context.Context, threadID string, body openai.BetaThreadUpdateParams) (openai.Thread, error)
• client.Beta.Threads.Delete(ctx context.Context, threadID string) (openai.ThreadDeleted, error)
• client.Beta.Threads.NewAndRun(ctx context.Context, body openai.BetaThreadNewAndRunParams) (openai.Run, error)

Runs

Response Types:

• openai.RequiredActionFunctionToolCall
• openai.Run
• openai.RunStatus

Methods:

• client.Beta.Threads.Runs.New(ctx context.Context, threadID string, params openai.BetaThreadRunNewParams) (openai.Run, error)
• client.Beta.Threads.Runs.Get(ctx context.Context, threadID string, runID string) (openai.Run, error)
• client.Beta.Threads.Runs.Update(ctx context.Context, threadID string, runID string, body openai.BetaThreadRunUpdateParams) (openai.Run, error)
• client.Beta.Threads.Runs.List(ctx context.Context, threadID string, query openai.BetaThreadRunListParams) (pagination.CursorPage[openai.Run], error)
• client.Beta.Threads.Runs.Cancel(ctx context.Context, threadID string, runID string) (openai.Run, error)
• client.Beta.Threads.Runs.SubmitToolOutputs(ctx context.Context, threadID string, runID string, body openai.BetaThreadRunSubmitToolOutputsParams) (openai.Run, error)

Steps

Params Types:

• openai.RunStepInclude

Response Types:

• openai.CodeInterpreterLogs
• openai.CodeInterpreterOutputImage
• openai.CodeInterpreterToolCall
• openai.CodeInterpreterToolCallDelta
• openai.FileSearchToolCall
• openai.FileSearchToolCallDelta
• openai.FunctionToolCall
• openai.FunctionToolCallDelta
• openai.MessageCreationStepDetails
• openai.RunStep
• openai.RunStepDelta
• openai.RunStepDeltaEvent
• openai.RunStepDeltaMessageDelta
• openai.ToolCall
• openai.ToolCallDelta
• openai.ToolCallDeltaObject
• openai.ToolCallsStepDetails

Methods:

• client.Beta.Threads.Runs.Steps.Get(ctx context.Context, threadID string, runID string, stepID string, query openai.BetaThreadRunStepGetParams) (openai.RunStep, error)
• client.Beta.Threads.Runs.Steps.List(ctx context.Context, threadID string, runID string, query openai.BetaThreadRunStepListParams) (pagination.CursorPage[openai.RunStep], error)

Messages

Params Types:

• openai.ImageFileParam
• openai.ImageFileContentBlockParam
• openai.ImageURLParam
• openai.ImageURLContentBlockParam
• openai.MessageContentPartParamUnion
• openai.TextContentBlockParam

Response Types:

• openai.Annotation
• openai.AnnotationDelta
• openai.FileCitationAnnotation
• openai.FileCitationDeltaAnnotation
• openai.FilePathAnnotation
• openai.FilePathDeltaAnnotation
• openai.ImageFile
• openai.ImageFileContentBlock
• openai.ImageFileDelta
• openai.ImageFileDeltaBlock
• openai.ImageURL
• openai.ImageURLContentBlock
• openai.ImageURLDelta
• openai.ImageURLDeltaBlock
• openai.Message
• openai.MessageContent
• openai.MessageContentDelta
• openai.MessageDeleted
• openai.MessageDelta
• openai.MessageDeltaEvent
• openai.RefusalContentBlock
• openai.RefusalDeltaBlock
• openai.Text
• openai.TextContentBlock
• openai.TextDelta
• openai.TextDeltaBlock

Methods:

• client.Beta.Threads.Messages.New(ctx context.Context, threadID string, body openai.BetaThreadMessageNewParams) (openai.Message, error)
• client.Beta.Threads.Messages.Get(ctx context.Context, threadID string, messageID string) (openai.Message, error)
• client.Beta.Threads.Messages.Update(ctx context.Context, threadID string, messageID string, body openai.BetaThreadMessageUpdateParams) (openai.Message, error)
• client.Beta.Threads.Messages.List(ctx context.Context, threadID string, query openai.BetaThreadMessageListParams) (pagination.CursorPage[openai.Message], error)
• client.Beta.Threads.Messages.Delete(ctx context.Context, threadID string, messageID string) (openai.MessageDeleted, error)

Batches

Response Types:

• openai.Batch
• openai.BatchError
• openai.BatchRequestCounts

Methods:

• client.Batches.New(ctx context.Context, body openai.BatchNewParams) (openai.Batch, error)
• client.Batches.Get(ctx context.Context, batchID string) (openai.Batch, error)
• client.Batches.List(ctx context.Context, query openai.BatchListParams) (pagination.CursorPage[openai.Batch], error)
• client.Batches.Cancel(ctx context.Context, batchID string) (openai.Batch, error)

Uploads

Response Types:

• openai.Upload

Methods:

• client.Uploads.New(ctx context.Context, body openai.UploadNewParams) (openai.Upload, error)
• client.Uploads.Cancel(ctx context.Context, uploadID string) (openai.Upload, error)
• client.Uploads.Complete(ctx context.Context, uploadID string, body openai.UploadCompleteParams) (openai.Upload, error)

Parts

Response Types:

• openai.UploadPart

Methods:

• client.Uploads.Parts.New(ctx context.Context, uploadID string, body openai.UploadPartNewParams) (openai.UploadPart, error)