client.Chat.Completions.Update(ctx context.Context, completionID string, body openai.ChatCompletionUpdateParams) (\*openai.ChatCompletion, error)

client.Chat.Completions.List(ctx context.Context, query openai.ChatCompletionListParams) (\*pagination.CursorPage[openai.ChatCompletion], error)

- client.Chat.Completions.Delete(ctx context.Context, completionID string) (\*openai.ChatCompletionDeleted, error) ### Messages Methods: -

client.Chat.Completions.Messages.List(ctx context.Context, completionID string, query openai.ChatCompletionMessageListParams) (\*pagination.CursorPage[openai.ChatCompletionStoreMessage], 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.CursorPage[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.ImageEditCompletedEvent - openai.ImageEditPartialImageEvent - openai.ImageEditStreamEventUnion - openai.ImageGenCompletedEvent - openai.ImageGenPartialImageEvent - openai.ImageGenStreamEventUnion - 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 Params Types: - openai.TranscriptionInclude Response Types: - openai.Transcription - openai.TranscriptionSegment - openai.TranscriptionStreamEventUnion - openai.TranscriptionTextDeltaEvent - openai.TranscriptionTextDoneEvent - openai.TranscriptionTextSegmentEvent - openai.TranscriptionVerbose - openai.TranscriptionWord - openai.AudioTranscriptionNewResponseUnion Methods: -

client.Audio.Transcriptions.New(ctx context.Context, body openai.AudioTranscriptionNewParams) (\*openai.AudioTranscriptionNewResponseUnion, 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 ## Methods Params Types: - openai.DpoHyperparameters - openai.DpoMethodParam - openai.ReinforcementHyperparameters - openai.ReinforcementMethodParam - openai.SupervisedHyperparameters - openai.SupervisedMethodParam Response Types: - openai.DpoHyperparametersResp - openai.DpoMethod - openai.ReinforcementHyperparametersResp - openai.ReinforcementMethod - openai.SupervisedHyperparametersResp - openai.SupervisedMethod ## 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)

- client.FineTuning.Jobs.Pause(ctx context.Context, fineTuningJobID string) (\*openai.FineTuningJob, error) - client.FineTuning.Jobs.Resume(ctx context.Context, fineTuningJobID string) (\*openai.FineTuningJob, 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)

## Checkpoints ### Permissions Response Types: - openai.FineTuningCheckpointPermissionNewResponse - openai.FineTuningCheckpointPermissionGetResponse - openai.FineTuningCheckpointPermissionListResponse - openai.FineTuningCheckpointPermissionDeleteResponse Methods: -

client.FineTuning.Checkpoints.Permissions.New(ctx context.Context, fineTunedModelCheckpoint string, body openai.FineTuningCheckpointPermissionNewParams) (\*pagination.Page[openai.FineTuningCheckpointPermissionNewResponse], error)

client.FineTuning.Checkpoints.Permissions.Get(ctx context.Context, fineTunedModelCheckpoint string, query openai.FineTuningCheckpointPermissionGetParams) (\*openai.FineTuningCheckpointPermissionGetResponse, error)

client.FineTuning.Checkpoints.Permissions.List(ctx context.Context, fineTunedModelCheckpoint string, query openai.FineTuningCheckpointPermissionListParams) (\*pagination.ConversationCursorPage[openai.FineTuningCheckpointPermissionListResponse], error)

client.FineTuning.Checkpoints.Permissions.Delete(ctx context.Context, fineTunedModelCheckpoint string, permissionID string) (\*openai.FineTuningCheckpointPermissionDeleteResponse, error)

## Alpha ### Graders Response Types: - openai.FineTuningAlphaGraderRunResponse - openai.FineTuningAlphaGraderValidateResponse Methods: -

client.FineTuning.Alpha.Graders.Run(ctx context.Context, body openai.FineTuningAlphaGraderRunParams) (\*openai.FineTuningAlphaGraderRunResponse, error)

client.FineTuning.Alpha.Graders.Validate(ctx context.Context, body openai.FineTuningAlphaGraderValidateParams) (\*openai.FineTuningAlphaGraderValidateResponse, error)

# Graders ## GraderModels Params Types: - openai.GraderInputsParam - openai.LabelModelGraderParam - openai.MultiGraderParam - openai.PythonGraderParam - openai.ScoreModelGraderParam - openai.StringCheckGraderParam - openai.TextSimilarityGraderParam Response Types: - openai.GraderInputs - openai.LabelModelGrader - openai.MultiGrader - openai.PythonGrader - openai.ScoreModelGrader - openai.StringCheckGrader - openai.TextSimilarityGrader # VectorStores Params Types: - openai.AutoFileChunkingStrategyParam - openai.FileChunkingStrategyParamUnion - openai.StaticFileChunkingStrategyParam - openai.StaticFileChunkingStrategyObjectParam Response Types: - openai.FileChunkingStrategyUnion - openai.OtherFileChunkingStrategyObject - openai.StaticFileChunkingStrategy - openai.StaticFileChunkingStrategyObject - openai.VectorStore - openai.VectorStoreDeleted - openai.VectorStoreSearchResponse Methods: - client.VectorStores.New(ctx context.Context, body openai.VectorStoreNewParams) (\*openai.VectorStore, error) - client.VectorStores.Get(ctx context.Context, vectorStoreID string) (\*openai.VectorStore, error) -

client.VectorStores.Update(ctx context.Context, vectorStoreID string, body openai.VectorStoreUpdateParams) (\*openai.VectorStore, error)

client.VectorStores.List(ctx context.Context, query openai.VectorStoreListParams) (\*pagination.CursorPage[openai.VectorStore], error)

- client.VectorStores.Delete(ctx context.Context, vectorStoreID string) (\*openai.VectorStoreDeleted, error) -

client.VectorStores.Search(ctx context.Context, vectorStoreID string, body openai.VectorStoreSearchParams) (\*pagination.Page[openai.VectorStoreSearchResponse], error)

## Files Response Types: - openai.VectorStoreFile - openai.VectorStoreFileDeleted - openai.VectorStoreFileContentResponse Methods: -

client.VectorStores.Files.New(ctx context.Context, vectorStoreID string, body openai.VectorStoreFileNewParams) (\*openai.VectorStoreFile, error)

client.VectorStores.Files.Get(ctx context.Context, vectorStoreID string, fileID string) (\*openai.VectorStoreFile, error)

client.VectorStores.Files.Update(ctx context.Context, vectorStoreID string, fileID string, body openai.VectorStoreFileUpdateParams) (\*openai.VectorStoreFile, error)

client.VectorStores.Files.List(ctx context.Context, vectorStoreID string, query openai.VectorStoreFileListParams) (\*pagination.CursorPage[openai.VectorStoreFile], error)

client.VectorStores.Files.Delete(ctx context.Context, vectorStoreID string, fileID string) (\*openai.VectorStoreFileDeleted, error)

client.VectorStores.Files.Content(ctx context.Context, vectorStoreID string, fileID string) (\*pagination.Page[openai.VectorStoreFileContentResponse], error)

## FileBatches Response Types: - openai.VectorStoreFileBatch Methods: -

client.VectorStores.FileBatches.New(ctx context.Context, vectorStoreID string, body openai.VectorStoreFileBatchNewParams) (\*openai.VectorStoreFileBatch, error)

client.VectorStores.FileBatches.Get(ctx context.Context, vectorStoreID string, batchID string) (\*openai.VectorStoreFileBatch, error)

client.VectorStores.FileBatches.Cancel(ctx context.Context, vectorStoreID string, batchID string) (\*openai.VectorStoreFileBatch, error)

client.VectorStores.FileBatches.ListFiles(ctx context.Context, vectorStoreID string, batchID string, query openai.VectorStoreFileBatchListFilesParams) (\*pagination.CursorPage[openai.VectorStoreFile], error)

# [Webhooks](webhooks/api.md) Methods: -

client.Webhooks.Unwrap(body []byte, headers http.Header, opts ...option.RequestOption) (*webhooks.UnwrapWebhookEventUnion, error)

client.Webhooks.UnwrapWithTolerance(body []byte, headers http.Header, tolerance time.Duration, opts ...option.RequestOption) (*webhooks.UnwrapWebhookEventUnion, error)

client.Webhooks.UnwrapWithToleranceAndTime(body []byte, headers http.Header, tolerance time.Duration, now time.Time, opts ...option.RequestOption) (*webhooks.UnwrapWebhookEventUnion, error)

- client.Webhooks.VerifySignature(body []byte, headers http.Header, opts ...option.RequestOption) error -

client.Webhooks.VerifySignatureWithTolerance(body []byte, headers http.Header, tolerance time.Duration, opts ...option.RequestOption) error

client.Webhooks.VerifySignatureWithToleranceAndTime(body []byte, headers http.Header, tolerance time.Duration, now time.Time, opts ...option.RequestOption) error

# Beta ## ChatKit Response Types: - openai.ChatKitWorkflow ### Sessions Methods: -

client.Beta.ChatKit.Sessions.New(ctx context.Context, body openai.BetaChatKitSessionNewParams) (\*openai.ChatSession, error)

client.Beta.ChatKit.Threads.List(ctx context.Context, query openai.BetaChatKitThreadListParams) (\*pagination.ConversationCursorPage[openai.ChatKitThread], error)

client.Beta.ChatKit.Threads.Delete(ctx context.Context, threadID string) (\*openai.BetaChatKitThreadDeleteResponse, error)

client.Beta.ChatKit.Threads.ListItems(ctx context.Context, threadID string, query openai.BetaChatKitThreadListItemsParams) (\*pagination.ConversationCursorPage[openai.ChatKitThreadItemListDataUnion], error)

## Assistants Params Types: - openai.AssistantToolUnionParam - openai.CodeInterpreterToolParam - openai.FileSearchToolParam - openai.FunctionToolParam Response Types: - openai.Assistant - openai.AssistantDeleted - openai.AssistantStreamEventUnion - openai.AssistantToolUnion - 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.AssistantResponseFormatOptionUnionParam - openai.AssistantToolChoiceParam - openai.AssistantToolChoiceFunctionParam - openai.AssistantToolChoiceOptionUnionParam Response Types: - openai.AssistantResponseFormatOptionUnion - 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.ToolCallUnion - openai.ToolCallDeltaUnion - 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.AnnotationUnion - openai.AnnotationDeltaUnion - 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.MessageContentUnion - openai.MessageContentDeltaUnion - 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 - openai.BatchUsage 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)

# [Responses](responses/api.md) # [Realtime](realtime/api.md) # [Conversations](conversations/api.md) # Containers Response Types: - openai.ContainerNewResponse - openai.ContainerGetResponse - openai.ContainerListResponse Methods: - client.Containers.New(ctx context.Context, body openai.ContainerNewParams) (\*openai.ContainerNewResponse, error) - client.Containers.Get(ctx context.Context, containerID string) (\*openai.ContainerGetResponse, error) -

client.Containers.List(ctx context.Context, query openai.ContainerListParams) (\*pagination.CursorPage[openai.ContainerListResponse], error)

- client.Containers.Delete(ctx context.Context, containerID string) error ## Files Response Types: - openai.ContainerFileNewResponse - openai.ContainerFileGetResponse - openai.ContainerFileListResponse Methods: -

client.Containers.Files.New(ctx context.Context, containerID string, body openai.ContainerFileNewParams) (\*openai.ContainerFileNewResponse, error)

client.Containers.Files.Get(ctx context.Context, containerID string, fileID string) (\*openai.ContainerFileGetResponse, error)

client.Containers.Files.List(ctx context.Context, containerID string, query openai.ContainerFileListParams) (\*pagination.CursorPage[openai.ContainerFileListResponse], error)

- client.Containers.Files.Delete(ctx context.Context, containerID string, fileID string) error ### Content Methods: - client.Containers.Files.Content.Get(ctx context.Context, containerID string, fileID string) (\*http.Response, error) # Skills Response Types: - openai.DeletedSkill - openai.Skill - openai.SkillList Methods: - client.Skills.New(ctx context.Context, body openai.SkillNewParams) (\*openai.Skill, error) - client.Skills.Get(ctx context.Context, skillID string) (\*openai.Skill, error) - client.Skills.Update(ctx context.Context, skillID string, body openai.SkillUpdateParams) (\*openai.Skill, error) - client.Skills.List(ctx context.Context, query openai.SkillListParams) (\*pagination.CursorPage[openai.Skill], error) - client.Skills.Delete(ctx context.Context, skillID string) (\*openai.DeletedSkill, error) ## Content Methods: - client.Skills.Content.Get(ctx context.Context, skillID string) (\*http.Response, error) ## Versions Response Types: - openai.DeletedSkillVersion - openai.SkillVersion - openai.SkillVersionList Methods: -

client.Skills.Versions.New(ctx context.Context, skillID string, body openai.SkillVersionNewParams) (\*openai.SkillVersion, error)

- client.Skills.Versions.Get(ctx context.Context, skillID string, version string) (\*openai.SkillVersion, error) -

client.Skills.Versions.List(ctx context.Context, skillID string, query openai.SkillVersionListParams) (\*pagination.CursorPage[openai.SkillVersion], error)

- client.Skills.Versions.Delete(ctx context.Context, skillID string, version string) (\*openai.DeletedSkillVersion, error) ### Content Methods: - client.Skills.Versions.Content.Get(ctx context.Context, skillID string, version string) (\*http.Response, error) # Videos Params Types: - openai.ImageInputReferenceParam - openai.VideoModel - openai.VideoSeconds - openai.VideoSize Response Types: - openai.Video - openai.VideoCreateError - openai.VideoModel - openai.VideoSeconds - openai.VideoSize - openai.VideoDeleteResponse - openai.VideoNewCharacterResponse - openai.VideoGetCharacterResponse Methods: - client.Videos.New(ctx context.Context, body openai.VideoNewParams) (\*openai.Video, error) - client.Videos.Get(ctx context.Context, videoID string) (\*openai.Video, error) -

client.Videos.List(ctx context.Context, query openai.VideoListParams) (\*pagination.ConversationCursorPage[openai.Video], error)

- client.Videos.Delete(ctx context.Context, videoID string) (\*openai.VideoDeleteResponse, error) -

client.Videos.NewCharacter(ctx context.Context, body openai.VideoNewCharacterParams) (\*openai.VideoNewCharacterResponse, error)

client.Videos.DownloadContent(ctx context.Context, videoID string, query openai.VideoDownloadContentParams) (\*http.Response, error)

- client.Videos.Edit(ctx context.Context, body openai.VideoEditParams) (\*openai.Video, error) - client.Videos.Extend(ctx context.Context, body openai.VideoExtendParams) (\*openai.Video, error) - client.Videos.GetCharacter(ctx context.Context, characterID string) (\*openai.VideoGetCharacterResponse, error) - client.Videos.Remix(ctx context.Context, videoID string, body openai.VideoRemixParams) (\*openai.Video, error)