# Shared Types: - AllModels - ChatModel - ComparisonFilter - CompoundFilter - CustomToolInputFormat - ErrorObject - FunctionDefinition - FunctionParameters - Metadata - Reasoning - ReasoningEffort - ResponseFormatJSONObject - ResponseFormatJSONSchema - ResponseFormatText - ResponseFormatTextGrammar - ResponseFormatTextPython - ResponsesModel # Completions Types: - Completion - CompletionChoice - CompletionUsage Methods: - client.completions.create({ ...params }) -> Completion # Chat Types: - ChatModel ## Completions Types: - ChatCompletion - ChatCompletionAllowedToolChoice - ChatCompletionAssistantMessageParam - ChatCompletionAudio - ChatCompletionAudioParam - ChatCompletionChunk - ChatCompletionContentPart - ChatCompletionContentPartImage - ChatCompletionContentPartInputAudio - ChatCompletionContentPartRefusal - ChatCompletionContentPartText - ChatCompletionCustomTool - ChatCompletionDeleted - ChatCompletionDeveloperMessageParam - ChatCompletionFunctionCallOption - ChatCompletionFunctionMessageParam - ChatCompletionFunctionTool - ChatCompletionMessage - ChatCompletionMessageCustomToolCall - ChatCompletionMessageFunctionToolCall - ChatCompletionMessageParam - ChatCompletionMessageToolCall - ChatCompletionModality - ChatCompletionNamedToolChoice - ChatCompletionNamedToolChoiceCustom - ChatCompletionPredictionContent - ChatCompletionRole - ChatCompletionStoreMessage - ChatCompletionStreamOptions - ChatCompletionSystemMessageParam - ChatCompletionTokenLogprob - ChatCompletionTool - ChatCompletionToolChoiceOption - ChatCompletionToolMessageParam - ChatCompletionUserMessageParam - ChatCompletionAllowedTools - ChatCompletionReasoningEffort Methods: - client.chat.completions.create({ ...params }) -> ChatCompletion - client.chat.completions.retrieve(completionID) -> ChatCompletion - client.chat.completions.update(completionID, { ...params }) -> ChatCompletion - client.chat.completions.list({ ...params }) -> ChatCompletionsPage - client.chat.completions.delete(completionID) -> ChatCompletionDeleted ### Messages Methods: - client.chat.completions.messages.list(completionID, { ...params }) -> ChatCompletionStoreMessagesPage # Embeddings Types: - CreateEmbeddingResponse - Embedding - EmbeddingModel Methods: - client.embeddings.create({ ...params }) -> CreateEmbeddingResponse # Files Types: - FileContent - FileDeleted - FileObject - FilePurpose Methods: - client.files.create({ ...params }) -> FileObject - client.files.retrieve(fileID) -> FileObject - client.files.list({ ...params }) -> FileObjectsPage - client.files.delete(fileID) -> FileDeleted - client.files.content(fileID) -> Response - client.files.waitForProcessing(id, { pollInterval = 5000, maxWait = 30 * 60 * 1000 }) -> Promise<FileObject> # Images Types: - Image - ImageEditCompletedEvent - ImageEditPartialImageEvent - ImageEditStreamEvent - ImageGenCompletedEvent - ImageGenPartialImageEvent - ImageGenStreamEvent - ImageModel - ImagesResponse Methods: - client.images.createVariation({ ...params }) -> ImagesResponse - client.images.edit({ ...params }) -> ImagesResponse - client.images.generate({ ...params }) -> ImagesResponse # Audio Types: - AudioModel - AudioResponseFormat ## Transcriptions Types: - Transcription - TranscriptionDiarized - TranscriptionDiarizedSegment - TranscriptionInclude - TranscriptionSegment - TranscriptionStreamEvent - TranscriptionTextDeltaEvent - TranscriptionTextDoneEvent - TranscriptionTextSegmentEvent - TranscriptionVerbose - TranscriptionWord - TranscriptionCreateResponse Methods: - client.audio.transcriptions.create({ ...params }) -> TranscriptionCreateResponse ## Translations Types: - Translation - TranslationVerbose - TranslationCreateResponse Methods: - client.audio.translations.create({ ...params }) -> TranslationCreateResponse ## Speech Types: - SpeechModel Methods: - client.audio.speech.create({ ...params }) -> Response # Moderations Types: - Moderation - ModerationImageURLInput - ModerationModel - ModerationMultiModalInput - ModerationTextInput - ModerationCreateResponse Methods: - client.moderations.create({ ...params }) -> ModerationCreateResponse # Models Types: - Model - ModelDeleted Methods: - client.models.retrieve(model) -> Model - client.models.list() -> ModelsPage - client.models.delete(model) -> ModelDeleted # FineTuning ## Methods Types: - DpoHyperparameters - DpoMethod - ReinforcementHyperparameters - ReinforcementMethod - SupervisedHyperparameters - SupervisedMethod ## Jobs Types: - FineTuningJob - FineTuningJobEvent - FineTuningJobWandbIntegration - FineTuningJobWandbIntegrationObject - FineTuningJobIntegration 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 - client.fineTuning.jobs.pause(fineTuningJobID) -> FineTuningJob - client.fineTuning.jobs.resume(fineTuningJobID) -> FineTuningJob ### Checkpoints Types: - FineTuningJobCheckpoint Methods: - client.fineTuning.jobs.checkpoints.list(fineTuningJobID, { ...params }) -> FineTuningJobCheckpointsPage ## Checkpoints ### Permissions Types: - PermissionCreateResponse - PermissionRetrieveResponse - PermissionListResponse - PermissionDeleteResponse Methods: -

client.fineTuning.checkpoints.permissions.create(fineTunedModelCheckpoint, { ...params }) -> PermissionCreateResponsesPage

client.fineTuning.checkpoints.permissions.retrieve(fineTunedModelCheckpoint, { ...params }) -> PermissionRetrieveResponse

- client.fineTuning.checkpoints.permissions.list(fineTunedModelCheckpoint, { ...params }) -> PermissionListResponsesPage - client.fineTuning.checkpoints.permissions.delete(permissionID, { ...params }) -> PermissionDeleteResponse ## Alpha ### Graders Types: - GraderRunResponse - GraderValidateResponse Methods: - client.fineTuning.alpha.graders.run({ ...params }) -> GraderRunResponse - client.fineTuning.alpha.graders.validate({ ...params }) -> GraderValidateResponse # Graders ## GraderModels Types: - GraderInputs - LabelModelGrader - MultiGrader - PythonGrader - ScoreModelGrader - StringCheckGrader - TextSimilarityGrader # VectorStores Types: - AutoFileChunkingStrategyParam - FileChunkingStrategy - FileChunkingStrategyParam - OtherFileChunkingStrategyObject - StaticFileChunkingStrategy - StaticFileChunkingStrategyObject - StaticFileChunkingStrategyObjectParam - VectorStore - VectorStoreDeleted - VectorStoreSearchResponse Methods: - client.vectorStores.create({ ...params }) -> VectorStore - client.vectorStores.retrieve(vectorStoreID) -> VectorStore - client.vectorStores.update(vectorStoreID, { ...params }) -> VectorStore - client.vectorStores.list({ ...params }) -> VectorStoresPage - client.vectorStores.delete(vectorStoreID) -> VectorStoreDeleted - client.vectorStores.search(vectorStoreID, { ...params }) -> VectorStoreSearchResponsesPage ## Files Types: - VectorStoreFile - VectorStoreFileDeleted - FileContentResponse Methods: - client.vectorStores.files.create(vectorStoreID, { ...params }) -> VectorStoreFile - client.vectorStores.files.retrieve(fileID, { ...params }) -> VectorStoreFile - client.vectorStores.files.update(fileID, { ...params }) -> VectorStoreFile - client.vectorStores.files.list(vectorStoreID, { ...params }) -> VectorStoreFilesPage - client.vectorStores.files.delete(fileID, { ...params }) -> VectorStoreFileDeleted - client.vectorStores.files.content(fileID, { ...params }) -> FileContentResponsesPage - client.vectorStores.files.createAndPoll(vectorStoreId, body, options?) -> Promise<VectorStoreFile> - client.vectorStores.files.poll(vectorStoreId, fileId, options?) -> Promise<VectorStoreFile> - client.vectorStores.files.upload(vectorStoreId, file, options?) -> Promise<VectorStoreFile> - client.vectorStores.files.uploadAndPoll(vectorStoreId, file, options?) -> Promise<VectorStoreFile> ## FileBatches Types: - VectorStoreFileBatch Methods: - client.vectorStores.fileBatches.create(vectorStoreID, { ...params }) -> VectorStoreFileBatch - client.vectorStores.fileBatches.retrieve(batchID, { ...params }) -> VectorStoreFileBatch - client.vectorStores.fileBatches.cancel(batchID, { ...params }) -> VectorStoreFileBatch - client.vectorStores.fileBatches.listFiles(batchID, { ...params }) -> VectorStoreFilesPage - client.vectorStores.fileBatches.createAndPoll(vectorStoreId, body, options?) -> Promise<VectorStoreFileBatch> - client.vectorStores.fileBatches.poll(vectorStoreId, batchId, options?) -> Promise<VectorStoreFileBatch> -

client.vectorStores.fileBatches.uploadAndPoll(vectorStoreId, { files, fileIds? }, options?) -> Promise<VectorStoreFileBatch>

# [Webhooks](src/resources/webhooks/api.md) # Beta ## ChatKit Types: - ChatKitWorkflow ### Sessions Methods: - client.beta.chatkit.sessions.create({ ...params }) -> ChatSession - client.beta.chatkit.sessions.cancel(sessionID) -> ChatSession ### Threads Types: - ChatSession - ChatSessionAutomaticThreadTitling - ChatSessionChatKitConfiguration - ChatSessionChatKitConfigurationParam - ChatSessionExpiresAfterParam - ChatSessionFileUpload - ChatSessionHistory - ChatSessionRateLimits - ChatSessionRateLimitsParam - ChatSessionStatus - ChatSessionWorkflowParam - ChatKitAttachment - ChatKitResponseOutputText - ChatKitThread - ChatKitThreadAssistantMessageItem - ChatKitThreadItemList - ChatKitThreadUserMessageItem - ChatKitWidgetItem - ThreadDeleteResponse Methods: - client.beta.chatkit.threads.retrieve(threadID) -> ChatKitThread - client.beta.chatkit.threads.list({ ...params }) -> ChatKitThreadsPage - client.beta.chatkit.threads.delete(threadID) -> ThreadDeleteResponse - client.beta.chatkit.threads.listItems(threadID, { ...params }) -> ChatKitThreadItemListDataPage ## Assistants Types: - Assistant - AssistantDeleted - AssistantStreamEvent - AssistantTool - CodeInterpreterTool - FileSearchTool - FunctionTool - MessageStreamEvent - RunStepStreamEvent - RunStreamEvent - ThreadStreamEvent 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.delete(assistantID) -> AssistantDeleted ## Threads Types: - AssistantResponseFormatOption - AssistantToolChoice - AssistantToolChoiceFunction - AssistantToolChoiceOption - 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.delete(threadID) -> ThreadDeleted - client.beta.threads.createAndRun({ ...params }) -> Run - client.beta.threads.createAndRunPoll(body, options?) -> Promise<Threads.Run> - client.beta.threads.createAndRunStream(body, options?) -> AssistantStream ### Runs Types: - RequiredActionFunctionToolCall - Run - RunStatus Methods: - client.beta.threads.runs.create(threadID, { ...params }) -> Run - client.beta.threads.runs.retrieve(runID, { ...params }) -> Run - client.beta.threads.runs.update(runID, { ...params }) -> Run - client.beta.threads.runs.list(threadID, { ...params }) -> RunsPage - client.beta.threads.runs.cancel(runID, { ...params }) -> Run - client.beta.threads.runs.submitToolOutputs(runID, { ...params }) -> Run - client.beta.threads.runs.createAndPoll(threadId, body, options?) -> Promise<Run> - client.beta.threads.runs.createAndStream(threadId, body, options?) -> AssistantStream - client.beta.threads.runs.poll(runId, params, options?) -> Promise<Run> - client.beta.threads.runs.stream(threadId, body, options?) -> AssistantStream - client.beta.threads.runs.submitToolOutputsAndPoll(runId, params, options?) -> Promise<Run> - client.beta.threads.runs.submitToolOutputsStream(runId, params, options?) -> AssistantStream #### Steps Types: - CodeInterpreterLogs - CodeInterpreterOutputImage - CodeInterpreterToolCall - CodeInterpreterToolCallDelta - FileSearchToolCall - FileSearchToolCallDelta - FunctionToolCall - FunctionToolCallDelta - MessageCreationStepDetails - RunStep - RunStepDelta - RunStepDeltaEvent - RunStepDeltaMessageDelta - RunStepInclude - ToolCall - ToolCallDelta - ToolCallDeltaObject - ToolCallsStepDetails Methods: - client.beta.threads.runs.steps.retrieve(stepID, { ...params }) -> RunStep - client.beta.threads.runs.steps.list(runID, { ...params }) -> RunStepsPage ### Messages Types: - Annotation - AnnotationDelta - FileCitationAnnotation - FileCitationDeltaAnnotation - FilePathAnnotation - FilePathDeltaAnnotation - ImageFile - ImageFileContentBlock - ImageFileDelta - ImageFileDeltaBlock - ImageURL - ImageURLContentBlock - ImageURLDelta - ImageURLDeltaBlock - Message - MessageContent - MessageContentDelta - MessageContentPartParam - MessageDeleted - MessageDelta - MessageDeltaEvent - RefusalContentBlock - RefusalDeltaBlock - Text - TextContentBlock - TextContentBlockParam - TextDelta - TextDeltaBlock Methods: - client.beta.threads.messages.create(threadID, { ...params }) -> Message - client.beta.threads.messages.retrieve(messageID, { ...params }) -> Message - client.beta.threads.messages.update(messageID, { ...params }) -> Message - client.beta.threads.messages.list(threadID, { ...params }) -> MessagesPage - client.beta.threads.messages.delete(messageID, { ...params }) -> MessageDeleted # Batches Types: - Batch - BatchError - BatchRequestCounts - BatchUsage Methods: - client.batches.create({ ...params }) -> Batch - client.batches.retrieve(batchID) -> Batch - client.batches.list({ ...params }) -> BatchesPage - client.batches.cancel(batchID) -> Batch # Uploads Types: - Upload Methods: - client.uploads.create({ ...params }) -> Upload - client.uploads.cancel(uploadID) -> Upload - client.uploads.complete(uploadID, { ...params }) -> Upload ## Parts Types: - UploadPart Methods: - client.uploads.parts.create(uploadID, { ...params }) -> UploadPart # [Responses](src/resources/responses/api.md) # [Realtime](src/resources/realtime/api.md) # [Conversations](src/resources/conversations/api.md) # Evals Types: - EvalCustomDataSourceConfig - EvalStoredCompletionsDataSourceConfig - EvalCreateResponse - EvalRetrieveResponse - EvalUpdateResponse - EvalListResponse - EvalDeleteResponse Methods: - client.evals.create({ ...params }) -> EvalCreateResponse - client.evals.retrieve(evalID) -> EvalRetrieveResponse - client.evals.update(evalID, { ...params }) -> EvalUpdateResponse - client.evals.list({ ...params }) -> EvalListResponsesPage - client.evals.delete(evalID) -> EvalDeleteResponse ## Runs Types: - CreateEvalCompletionsRunDataSource - CreateEvalJSONLRunDataSource - EvalAPIError - RunCreateResponse - RunRetrieveResponse - RunListResponse - RunDeleteResponse - RunCancelResponse Methods: - client.evals.runs.create(evalID, { ...params }) -> RunCreateResponse - client.evals.runs.retrieve(runID, { ...params }) -> RunRetrieveResponse - client.evals.runs.list(evalID, { ...params }) -> RunListResponsesPage - client.evals.runs.delete(runID, { ...params }) -> RunDeleteResponse - client.evals.runs.cancel(runID, { ...params }) -> RunCancelResponse ### OutputItems Types: - OutputItemRetrieveResponse - OutputItemListResponse Methods: - client.evals.runs.outputItems.retrieve(outputItemID, { ...params }) -> OutputItemRetrieveResponse - client.evals.runs.outputItems.list(runID, { ...params }) -> OutputItemListResponsesPage # Containers Types: - ContainerCreateResponse - ContainerRetrieveResponse - ContainerListResponse Methods: - client.containers.create({ ...params }) -> ContainerCreateResponse - client.containers.retrieve(containerID) -> ContainerRetrieveResponse - client.containers.list({ ...params }) -> ContainerListResponsesPage - client.containers.delete(containerID) -> void ## Files Types: - FileCreateResponse - FileRetrieveResponse - FileListResponse Methods: - client.containers.files.create(containerID, { ...params }) -> FileCreateResponse - client.containers.files.retrieve(fileID, { ...params }) -> FileRetrieveResponse - client.containers.files.list(containerID, { ...params }) -> FileListResponsesPage - client.containers.files.delete(fileID, { ...params }) -> void ### Content Methods: - client.containers.files.content.retrieve(fileID, { ...params }) -> Response # Skills Types: - DeletedSkill - Skill - SkillList Methods: - client.skills.create({ ...params }) -> Skill - client.skills.retrieve(skillID) -> Skill - client.skills.update(skillID, { ...params }) -> Skill - client.skills.list({ ...params }) -> SkillsPage - client.skills.delete(skillID) -> DeletedSkill ## Content Methods: - client.skills.content.retrieve(skillID) -> Response ## Versions Types: - DeletedSkillVersion - SkillVersion - SkillVersionList Methods: - client.skills.versions.create(skillID, { ...params }) -> SkillVersion - client.skills.versions.retrieve(version, { ...params }) -> SkillVersion - client.skills.versions.list(skillID, { ...params }) -> SkillVersionsPage - client.skills.versions.delete(version, { ...params }) -> DeletedSkillVersion ### Content Methods: - client.skills.versions.content.retrieve(version, { ...params }) -> Response # Videos Types: - ImageInputReferenceParam - Video - VideoCreateError - VideoModel - VideoSeconds - VideoSize - VideoDeleteResponse - VideoCreateCharacterResponse - VideoGetCharacterResponse Methods: - client.videos.create({ ...params }) -> Video - client.videos.retrieve(videoID) -> Video - client.videos.list({ ...params }) -> VideosPage - client.videos.delete(videoID) -> VideoDeleteResponse - client.videos.createCharacter({ ...params }) -> VideoCreateCharacterResponse - client.videos.downloadContent(videoID, { ...params }) -> Response - client.videos.edit({ ...params }) -> Video - client.videos.extend({ ...params }) -> Video - client.videos.getCharacter(characterID) -> VideoGetCharacterResponse - client.videos.remix(videoID, { ...params }) -> Video