# Shared Types: - AllModels - ChatModel - ComparisonFilter - CompoundFilter - CustomToolInputFormat - ErrorObject - FunctionDefinition - FunctionParameters - Metadata - OAuthErrorCode - 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 # ContentProvenanceChecks Types: - ContentProvenanceCheck Methods: - client.contentProvenanceChecks.create({ ...params }) -> ContentProvenanceCheck # Audio Types: - AudioModel - AudioResponseFormat ## Transcriptions Types: - Transcription - TranscriptionDiarized - TranscriptionDiarizedSegment - TranscriptionInclude - TranscriptionLanguage - 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> # Safety ## Alerts Types: - SafetyAlert Methods: - client.safety.alerts.retrieve(id) -> SafetyAlert # Safety ## Alerts Types: - SafetyAlert Methods: - client.safety.alerts.retrieve(id) -> SafetyAlert # [Webhooks](src/resources/webhooks/api.md) # Beta ## Agents Types: - Agent - AgentCloseSubagentCallItem - AgentCommandExecutionItem - AgentContent - AgentCreateSubagentCallItem - AgentDeleted - AgentFunctionCallItem - AgentFunctionCallOutput - AgentFunctionCallOutputParam - AgentFunctionCallStatus - AgentInterruptSubagentCallItem - AgentMcpCallItem - AgentOutputCommandExecutionOutputDeltaEvent - AgentOutputItem - AgentOutputItemStatus - AgentReasoning - AgentReasoningItem - AgentReasoningParam - AgentResumeSubagentCallItem - AgentSendSubagentInputCallItem - AgentSession - AgentSessionAssistantMessage - AgentSessionCreatedEvent - AgentSessionDeleted - AgentSessionEnvironmentConnectedEvent - AgentSessionEnvironmentDisconnectedEvent - AgentSessionEnvironmentFailedEvent - AgentSessionEnvironmentPendingEvent - AgentSessionEnvironmentReadyEvent - AgentSessionEnvironmentState - AgentSessionErrorEvent - AgentSessionEvent - AgentSessionFailedEvent - AgentSessionIdleEvent - AgentSessionInProgressEvent - AgentSessionInputMessageParam - AgentSessionInputParam - AgentSessionItem - AgentSessionMessage - AgentSessionMessageContent - AgentSessionRequiresActionEvent - AgentSessionSubagentActiveEvent - AgentSessionSubagentClosedEvent - AgentSessionSubagentCreatedEvent - AgentSessionTurnCancelledEvent - AgentSessionTurnCompletedEvent - AgentSessionTurnContentPartAddedEvent - AgentSessionTurnContentPartDoneEvent - AgentSessionTurnCreatedEvent - AgentSessionTurnFailedEvent - AgentSessionTurnInProgressEvent - AgentSessionTurnItemAddedEvent - AgentSessionTurnItemDoneEvent - AgentSessionTurnOutputTextDeltaEvent - AgentSessionTurnOutputTextDoneEvent - AgentSessionTurnReasoningSummaryPartAddedEvent - AgentSessionTurnReasoningSummaryPartDoneEvent - AgentSessionTurnReasoningSummaryTextDeltaEvent - AgentSessionTurnReasoningSummaryTextDoneEvent - AgentText - AgentTextParam - AgentTool - AgentToolParam - AgentWaitForSubagentsCallItem - AgentWebSearchCallItem - Environment - EnvironmentParam - HostedEnvironmentFile - HostedEnvironmentFileID - HostedEnvironmentFileParam - HostedPlugin - HostedPluginParam - HostedSkill - HostedSkillParam - HostedSkillReference - InlineCapabilitySourceParam - InputContent - InputContentParam - McpTransport - McpTransportParam - MultiAgentConfig - MultiAgentConfigParam - OutputText - PersistedAgentTool - PersistedAgentToolParam - PersistedMcpTransport - PersistedMcpTransportParam - SessionError - SessionTurnError - SetupCommandParam - Subagent - SummaryText - TextFormat - TextFormatParam - TokenUsage - WebSearchAction Methods: - client.beta.agents.create({ ...params }) -> Agent - client.beta.agents.retrieve(agentID) -> Agent - client.beta.agents.update(agentID, { ...params }) -> Agent - client.beta.agents.list({ ...params }) -> AgentsPage - client.beta.agents.delete(agentID) -> AgentDeleted ### Environments Types: - EnvironmentInfo Methods: - client.beta.agents.environments.retrieve(environmentID) -> EnvironmentInfo #### Files Types: - EnvironmentFile Methods: - client.beta.agents.environments.files.create(environmentID, { ...params }) -> EnvironmentFile - client.beta.agents.environments.files.list(environmentID, { ...params }) -> EnvironmentFilesPage #### Templates Types: - EnvironmentTemplate - EnvironmentTemplateDeleted Methods: - client.beta.agents.environments.templates.create({ ...params }) -> EnvironmentTemplate - client.beta.agents.environments.templates.retrieve(environmentTemplateID) -> EnvironmentTemplate - client.beta.agents.environments.templates.update(environmentTemplateID, { ...params }) -> EnvironmentTemplate - client.beta.agents.environments.templates.list({ ...params }) -> EnvironmentTemplatesPage - client.beta.agents.environments.templates.delete(environmentTemplateID) -> EnvironmentTemplateDeleted ### Vaults Types: - Vault - VaultDeleted - VaultStatus - VaultStatusFilter Methods: - client.beta.agents.vaults.create({ ...params }) -> Vault - client.beta.agents.vaults.retrieve(vaultID) -> Vault - client.beta.agents.vaults.list({ ...params }) -> VaultsPage - client.beta.agents.vaults.delete(vaultID) -> VaultDeleted #### Credentials Types: - Credential - CredentialAuth - CredentialAuthCreateParam - CredentialAuthRotateParam - CredentialDeleted - CredentialNetworking - CredentialNetworkingParam - McpOauthTokenEndpointAuth - McpOauthTokenEndpointAuthCreateParam - McpOauthTokenEndpointAuthRotateParam Methods: - client.beta.agents.vaults.credentials.create(vaultID, { ...params }) -> Credential - client.beta.agents.vaults.credentials.retrieve(credentialID, { ...params }) -> Credential - client.beta.agents.vaults.credentials.update(credentialID, { ...params }) -> Credential - client.beta.agents.vaults.credentials.list(vaultID, { ...params }) -> CredentialsPage - client.beta.agents.vaults.credentials.delete(credentialID, { ...params }) -> CredentialDeleted ### Sessions Methods: - client.beta.agents.sessions.create({ ...params }) -> AgentSession - client.beta.agents.sessions.retrieve(sessionID) -> AgentSession - client.beta.agents.sessions.update(sessionID, { ...params }) -> AgentSession - client.beta.agents.sessions.list({ ...params }) -> AgentSessionsPage - client.beta.agents.sessions.delete(sessionID) -> AgentSessionDeleted #### Subagents Methods: - client.beta.agents.sessions.subagents.retrieve(subagentID, { ...params }) -> Subagent - client.beta.agents.sessions.subagents.list(sessionID, { ...params }) -> SubagentsPage ##### Items Methods: - client.beta.agents.sessions.subagents.items.list(subagentID, { ...params }) -> AgentSessionItemsPage ##### Turns Methods: - client.beta.agents.sessions.subagents.turns.retrieve(turnID, { ...params }) -> Turn - client.beta.agents.sessions.subagents.turns.list(subagentID, { ...params }) -> TurnsPage ###### Items Methods: - client.beta.agents.sessions.subagents.turns.items.list(turnID, { ...params }) -> AgentSessionItemsPage #### Artifacts Types: - SessionArtifact - SessionArtifactDeleted Methods: - client.beta.agents.sessions.artifacts.retrieve(artifactID, { ...params }) -> SessionArtifact - client.beta.agents.sessions.artifacts.list(sessionID, { ...params }) -> SessionArtifactsPage - client.beta.agents.sessions.artifacts.delete(artifactID, { ...params }) -> SessionArtifactDeleted - client.beta.agents.sessions.artifacts.content(artifactID, { ...params }) -> Response #### Items Methods: - client.beta.agents.sessions.items.list(sessionID, { ...params }) -> AgentSessionItemsPage #### Events Methods: - client.beta.agents.sessions.events.create(sessionID, { ...params }) -> void - client.beta.agents.sessions.events.stream(sessionID) -> AgentSessionEvent #### Turns Types: - Turn Methods: - client.beta.agents.sessions.turns.retrieve(turnID, { ...params }) -> Turn - client.beta.agents.sessions.turns.list(sessionID, { ...params }) -> TurnsPage ## Responses Types: - BetaApplyPatchTool - BetaCompactedResponse - BetaComputerAction - BetaComputerActionList - BetaComputerTool - BetaComputerUsePreviewTool - BetaContainerAuto - BetaContainerNetworkPolicyAllowlist - BetaContainerNetworkPolicyDisabled - BetaContainerNetworkPolicyDomainSecret - BetaContainerReference - BetaCustomTool - BetaEasyInputMessage - BetaFileSearchTool - BetaFunctionShellTool - BetaFunctionTool - BetaImageDetail - BetaInlineSkill - BetaInlineSkillSource - BetaLocalEnvironment - BetaLocalSkill - BetaMcpToolCallError - BetaNamespaceTool - BetaResponse - BetaResponseApplyPatchToolCall - BetaResponseApplyPatchToolCallOutput - BetaResponseAudioDeltaEvent - BetaResponseAudioDoneEvent - BetaResponseAudioTranscriptDeltaEvent - BetaResponseAudioTranscriptDoneEvent - BetaResponseCodeInterpreterCallCodeDeltaEvent - BetaResponseCodeInterpreterCallCodeDoneEvent - BetaResponseCodeInterpreterCallCompletedEvent - BetaResponseCodeInterpreterCallInProgressEvent - BetaResponseCodeInterpreterCallInterpretingEvent - BetaResponseCodeInterpreterToolCall - BetaResponseCompactionCompactingEvent - BetaResponseCompactionItem - BetaResponseCompactionItemParam - BetaResponseCompletedEvent - BetaResponseComputerToolCall - BetaResponseComputerToolCallOutputItem - BetaResponseComputerToolCallOutputScreenshot - BetaResponseConfigurationUpdateItem - BetaResponseConfigurationUpdateItemParam - BetaResponseContainerReference - BetaResponseContent - BetaResponseContentPartAddedEvent - BetaResponseContentPartDoneEvent - BetaResponseConversationParam - BetaResponseCreatedEvent - BetaResponseCustomToolCall - BetaResponseCustomToolCallInputDeltaEvent - BetaResponseCustomToolCallInputDoneEvent - BetaResponseCustomToolCallItem - BetaResponseCustomToolCallOutput - BetaResponseCustomToolCallOutputItem - BetaResponseError - BetaResponseErrorEvent - BetaResponseFailedEvent - BetaResponseFileSearchCallCompletedEvent - BetaResponseFileSearchCallInProgressEvent - BetaResponseFileSearchCallSearchingEvent - BetaResponseFileSearchToolCall - BetaResponseFormatTextConfig - BetaResponseFormatTextJSONSchemaConfig - BetaResponseFunctionCallArgumentsDeltaEvent - BetaResponseFunctionCallArgumentsDoneEvent - BetaResponseFunctionCallOutputItem - BetaResponseFunctionCallOutputItemList - BetaResponseFunctionShellCallOutputContent - BetaResponseFunctionShellToolCall - BetaResponseFunctionShellToolCallOutput - BetaResponseFunctionToolCall - BetaResponseFunctionToolCallItem - BetaResponseFunctionToolCallOutputItem - BetaResponseFunctionWebSearch - BetaResponseImageGenCallCompletedEvent - BetaResponseImageGenCallGeneratingEvent - BetaResponseImageGenCallInProgressEvent - BetaResponseImageGenCallPartialImageEvent - BetaResponseInProgressEvent - BetaResponseIncludable - BetaResponseIncompleteEvent - BetaResponseInjectCreatedEvent - BetaResponseInjectEvent - BetaResponseInjectFailedEvent - BetaResponseInput - BetaResponseInputAudio - BetaResponseInputContent - BetaResponseInputFile - BetaResponseInputFileContent - BetaResponseInputImage - BetaResponseInputImageContent - BetaResponseInputItem - BetaResponseInputMessageContentList - BetaResponseInputMessageItem - BetaResponseInputText - BetaResponseInputTextContent - BetaResponseItem - BetaResponseLocalEnvironment - BetaResponseMcpCallArgumentsDeltaEvent - BetaResponseMcpCallArgumentsDoneEvent - BetaResponseMcpCallCompletedEvent - BetaResponseMcpCallFailedEvent - BetaResponseMcpCallInProgressEvent - BetaResponseMcpListToolsCompletedEvent - BetaResponseMcpListToolsFailedEvent - BetaResponseMcpListToolsInProgressEvent - BetaResponseOutputAudio - BetaResponseOutputItem - BetaResponseOutputItemAddedEvent - BetaResponseOutputItemDoneEvent - BetaResponseOutputMessage - BetaResponseOutputRefusal - BetaResponseOutputText - BetaResponseOutputTextAnnotationAddedEvent - BetaResponsePrompt - BetaResponseQueuedEvent - BetaResponseReasoningItem - BetaResponseReasoningSummaryPartAddedEvent - BetaResponseReasoningSummaryPartDoneEvent - BetaResponseReasoningSummaryTextDeltaEvent - BetaResponseReasoningSummaryTextDoneEvent - BetaResponseReasoningTextDeltaEvent - BetaResponseReasoningTextDoneEvent - BetaResponseRefusalDeltaEvent - BetaResponseRefusalDoneEvent - BetaResponseShellCallCommandAddedEvent - BetaResponseShellCallCommandDeltaEvent - BetaResponseShellCallCommandDoneEvent - BetaResponseShellCallOutputContentDeltaEvent - BetaResponseShellCallOutputContentDoneEvent - BetaResponseStatus - BetaResponseSteerAcceptedEvent - BetaResponseSteerErrorCode - BetaResponseSteerEvent - BetaResponseSteerFailedEvent - BetaResponseSteerInput - BetaResponseSteerInputContent - BetaResponseSteerPendingEvent - BetaResponseSteerPendingReason - BetaResponseSteerRequiredInput - BetaResponseStreamEvent - BetaResponseTextConfig - BetaResponseTextDeltaEvent - BetaResponseTextDoneEvent - BetaResponseToolSearchCall - BetaResponseToolSearchOutputItem - BetaResponseToolSearchOutputItemParam - BetaResponseUsage - BetaResponseWebSearchCallCompletedEvent - BetaResponseWebSearchCallInProgressEvent - BetaResponseWebSearchCallSearchingEvent - BetaResponsesClientEvent - BetaResponsesServerEvent - BetaServiceTier - BetaSkillReference - BetaTool - BetaToolChoiceAllowed - BetaToolChoiceApplyPatch - BetaToolChoiceCustom - BetaToolChoiceFunction - BetaToolChoiceMcp - BetaToolChoiceOptions - BetaToolChoiceShell - BetaToolChoiceTypes - BetaToolSearchTool - BetaWebSearchPreviewTool - BetaWebSearchTool Methods: - client.beta.responses.create({ ...params }) -> BetaResponse - client.beta.responses.retrieve(responseID, { ...params }) -> BetaResponse - client.beta.responses.delete(responseID, { ...params }) -> void - client.beta.responses.cancel(responseID, { ...params }) -> BetaResponse - client.beta.responses.compact({ ...params }) -> BetaCompactedResponse ### InputItems Types: - BetaResponseItemList Methods: - client.beta.responses.inputItems.list(responseID, { ...params }) -> BetaResponseItemsPage ### InputTokens Types: - InputTokenCountResponse Methods: - client.beta.responses.inputTokens.count({ ...params }) -> InputTokenCountResponse ## 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 # Admin ## Organization ### AuditLogs Types: - AuditLogListResponse Methods: - client.admin.organization.auditLogs.list({ ...params }) -> AuditLogListResponsesPage ### AdminAPIKeys Types: - AdminAPIKey - AdminAPIKeyCreateResponse - AdminAPIKeyDeleteResponse Methods: - client.admin.organization.adminAPIKeys.create({ ...params }) -> AdminAPIKeyCreateResponse - client.admin.organization.adminAPIKeys.retrieve(keyID) -> AdminAPIKey - client.admin.organization.adminAPIKeys.list({ ...params }) -> AdminAPIKeysPage - client.admin.organization.adminAPIKeys.delete(keyID) -> AdminAPIKeyDeleteResponse ### Usage Types: - CostQuantityUnit - UsageAudioSpeechesResponse - UsageAudioTranscriptionsResponse - UsageCodeInterpreterSessionsResponse - UsageCompletionsResponse - UsageCostsResponse - UsageEmbeddingsResponse - UsageFileSearchCallsResponse - UsageImagesResponse - UsageModerationsResponse - UsageVectorStoresResponse - UsageWebSearchCallsResponse Methods: - client.admin.organization.usage.audioSpeeches({ ...params }) -> UsageAudioSpeechesResponse - client.admin.organization.usage.audioTranscriptions({ ...params }) -> UsageAudioTranscriptionsResponse - client.admin.organization.usage.codeInterpreterSessions({ ...params }) -> UsageCodeInterpreterSessionsResponse - client.admin.organization.usage.completions({ ...params }) -> UsageCompletionsResponse - client.admin.organization.usage.costs({ ...params }) -> UsageCostsResponse - client.admin.organization.usage.embeddings({ ...params }) -> UsageEmbeddingsResponse - client.admin.organization.usage.fileSearchCalls({ ...params }) -> UsageFileSearchCallsResponse - client.admin.organization.usage.images({ ...params }) -> UsageImagesResponse - client.admin.organization.usage.moderations({ ...params }) -> UsageModerationsResponse - client.admin.organization.usage.vectorStores({ ...params }) -> UsageVectorStoresResponse - client.admin.organization.usage.webSearchCalls({ ...params }) -> UsageWebSearchCallsResponse ### Invites Types: - Invite - InviteDeleteResponse Methods: - client.admin.organization.invites.create({ ...params }) -> Invite - client.admin.organization.invites.retrieve(inviteID) -> Invite - client.admin.organization.invites.list({ ...params }) -> InvitesPage - client.admin.organization.invites.delete(inviteID) -> InviteDeleteResponse ### Users Types: - OrganizationUser - UserDeleteResponse Methods: - client.admin.organization.users.retrieve(userID) -> OrganizationUser - client.admin.organization.users.update(userID, { ...params }) -> OrganizationUser - client.admin.organization.users.list({ ...params }) -> OrganizationUsersPage - client.admin.organization.users.delete(userID) -> UserDeleteResponse #### Roles Types: - RoleCreateResponse - RoleRetrieveResponse - RoleListResponse - RoleDeleteResponse Methods: - client.admin.organization.users.roles.create(userID, { ...params }) -> RoleCreateResponse - client.admin.organization.users.roles.retrieve(roleID, { ...params }) -> RoleRetrieveResponse - client.admin.organization.users.roles.list(userID, { ...params }) -> RoleListResponsesPage - client.admin.organization.users.roles.delete(roleID, { ...params }) -> RoleDeleteResponse ### Groups Types: - Group - GroupUpdateResponse - GroupDeleteResponse Methods: - client.admin.organization.groups.create({ ...params }) -> Group - client.admin.organization.groups.retrieve(groupID) -> Group - client.admin.organization.groups.update(groupID, { ...params }) -> GroupUpdateResponse - client.admin.organization.groups.list({ ...params }) -> GroupsPage - client.admin.organization.groups.delete(groupID) -> GroupDeleteResponse #### Users Types: - OrganizationGroupUser - UserCreateResponse - UserRetrieveResponse - UserDeleteResponse Methods: - client.admin.organization.groups.users.create(groupID, { ...params }) -> UserCreateResponse - client.admin.organization.groups.users.retrieve(userID, { ...params }) -> UserRetrieveResponse - client.admin.organization.groups.users.list(groupID, { ...params }) -> OrganizationGroupUsersPage - client.admin.organization.groups.users.delete(userID, { ...params }) -> UserDeleteResponse #### Roles Types: - RoleCreateResponse - RoleRetrieveResponse - RoleListResponse - RoleDeleteResponse Methods: - client.admin.organization.groups.roles.create(groupID, { ...params }) -> RoleCreateResponse - client.admin.organization.groups.roles.retrieve(roleID, { ...params }) -> RoleRetrieveResponse - client.admin.organization.groups.roles.list(groupID, { ...params }) -> RoleListResponsesPage - client.admin.organization.groups.roles.delete(roleID, { ...params }) -> RoleDeleteResponse ### Roles Types: - Role - RoleDeleteResponse Methods: - client.admin.organization.roles.create({ ...params }) -> Role - client.admin.organization.roles.retrieve(roleID) -> Role - client.admin.organization.roles.update(roleID, { ...params }) -> Role - client.admin.organization.roles.list({ ...params }) -> RolesPage - client.admin.organization.roles.delete(roleID) -> RoleDeleteResponse ### DataRetention Types: - OrganizationDataRetention Methods: - client.admin.organization.dataRetention.retrieve() -> OrganizationDataRetention - client.admin.organization.dataRetention.update({ ...params }) -> OrganizationDataRetention ### SpendLimit Types: - OrganizationSpendLimit - OrganizationSpendLimitDeleted Methods: - client.admin.organization.spendLimit.retrieve() -> OrganizationSpendLimit - client.admin.organization.spendLimit.update({ ...params }) -> OrganizationSpendLimit - client.admin.organization.spendLimit.delete() -> OrganizationSpendLimitDeleted ### SpendAlerts Types: - OrganizationSpendAlert - OrganizationSpendAlertDeleted Methods: - client.admin.organization.spendAlerts.create({ ...params }) -> OrganizationSpendAlert - client.admin.organization.spendAlerts.retrieve(alertID) -> OrganizationSpendAlert - client.admin.organization.spendAlerts.update(alertID, { ...params }) -> OrganizationSpendAlert - client.admin.organization.spendAlerts.list({ ...params }) -> OrganizationSpendAlertsPage - client.admin.organization.spendAlerts.delete(alertID) -> OrganizationSpendAlertDeleted ### Certificates Types: - Certificate - CertificateListResponse - CertificateDeleteResponse - CertificateActivateResponse - CertificateDeactivateResponse Methods: - client.admin.organization.certificates.create({ ...params }) -> Certificate - client.admin.organization.certificates.retrieve(certificateID, { ...params }) -> Certificate - client.admin.organization.certificates.update(certificateID, { ...params }) -> Certificate - client.admin.organization.certificates.list({ ...params }) -> CertificateListResponsesPage - client.admin.organization.certificates.delete(certificateID) -> CertificateDeleteResponse - client.admin.organization.certificates.activate({ ...params }) -> CertificateActivateResponsesPage - client.admin.organization.certificates.deactivate({ ...params }) -> CertificateDeactivateResponsesPage ### Projects Types: - Project - ProjectResidency Methods: - client.admin.organization.projects.create({ ...params }) -> Project - client.admin.organization.projects.retrieve(projectID) -> Project - client.admin.organization.projects.update(projectID, { ...params }) -> Project - client.admin.organization.projects.list({ ...params }) -> ProjectsPage - client.admin.organization.projects.archive(projectID) -> Project #### Users Types: - ProjectUser - UserDeleteResponse Methods: - client.admin.organization.projects.users.create(projectID, { ...params }) -> ProjectUser - client.admin.organization.projects.users.retrieve(userID, { ...params }) -> ProjectUser - client.admin.organization.projects.users.update(userID, { ...params }) -> ProjectUser - client.admin.organization.projects.users.list(projectID, { ...params }) -> ProjectUsersPage - client.admin.organization.projects.users.delete(userID, { ...params }) -> UserDeleteResponse ##### Roles Types: - RoleCreateResponse - RoleRetrieveResponse - RoleListResponse - RoleDeleteResponse Methods: - client.admin.organization.projects.users.roles.create(userID, { ...params }) -> RoleCreateResponse - client.admin.organization.projects.users.roles.retrieve(roleID, { ...params }) -> RoleRetrieveResponse - client.admin.organization.projects.users.roles.list(userID, { ...params }) -> RoleListResponsesPage - client.admin.organization.projects.users.roles.delete(roleID, { ...params }) -> RoleDeleteResponse #### ServiceAccounts Types: - ProjectServiceAccount - ServiceAccountCreateResponse - ServiceAccountDeleteResponse Methods: - client.admin.organization.projects.serviceAccounts.create(projectID, { ...params }) -> ServiceAccountCreateResponse - client.admin.organization.projects.serviceAccounts.retrieve(serviceAccountID, { ...params }) -> ProjectServiceAccount - client.admin.organization.projects.serviceAccounts.update(serviceAccountID, { ...params }) -> ProjectServiceAccount - client.admin.organization.projects.serviceAccounts.list(projectID, { ...params }) -> ProjectServiceAccountsPage - client.admin.organization.projects.serviceAccounts.delete(serviceAccountID, { ...params }) -> ServiceAccountDeleteResponse ##### APIKeys Types: - APIKeyCreateResponse Methods: - client.admin.organization.projects.serviceAccounts.apiKeys.create(serviceAccountID, { ...params }) -> APIKeyCreateResponse #### APIKeys Types: - ProjectAPIKey - APIKeyDeleteResponse Methods: - client.admin.organization.projects.apiKeys.retrieve(apiKeyID, { ...params }) -> ProjectAPIKey - client.admin.organization.projects.apiKeys.list(projectID, { ...params }) -> ProjectAPIKeysPage - client.admin.organization.projects.apiKeys.delete(apiKeyID, { ...params }) -> APIKeyDeleteResponse #### RateLimits Types: - ProjectRateLimit Methods: - client.admin.organization.projects.rateLimits.listRateLimits(projectID, { ...params }) -> ProjectRateLimitsPage - client.admin.organization.projects.rateLimits.updateRateLimit(rateLimitID, { ...params }) -> ProjectRateLimit #### ModelPermissions Types: - ProjectModelPermissions - ProjectModelPermissionsDeleted Methods: - client.admin.organization.projects.modelPermissions.retrieve(projectID) -> ProjectModelPermissions - client.admin.organization.projects.modelPermissions.update(projectID, { ...params }) -> ProjectModelPermissions - client.admin.organization.projects.modelPermissions.delete(projectID) -> ProjectModelPermissionsDeleted #### HostedToolPermissions Types: - ProjectHostedToolPermissions Methods: - client.admin.organization.projects.hostedToolPermissions.retrieve(projectID) -> ProjectHostedToolPermissions - client.admin.organization.projects.hostedToolPermissions.update(projectID, { ...params }) -> ProjectHostedToolPermissions #### Groups Types: - ProjectGroup - GroupDeleteResponse Methods: - client.admin.organization.projects.groups.create(projectID, { ...params }) -> ProjectGroup - client.admin.organization.projects.groups.retrieve(groupID, { ...params }) -> ProjectGroup - client.admin.organization.projects.groups.list(projectID, { ...params }) -> ProjectGroupsPage - client.admin.organization.projects.groups.delete(groupID, { ...params }) -> GroupDeleteResponse ##### Roles Types: - RoleCreateResponse - RoleRetrieveResponse - RoleListResponse - RoleDeleteResponse Methods: - client.admin.organization.projects.groups.roles.create(groupID, { ...params }) -> RoleCreateResponse - client.admin.organization.projects.groups.roles.retrieve(roleID, { ...params }) -> RoleRetrieveResponse - client.admin.organization.projects.groups.roles.list(groupID, { ...params }) -> RoleListResponsesPage - client.admin.organization.projects.groups.roles.delete(roleID, { ...params }) -> RoleDeleteResponse #### Roles Types: - RoleDeleteResponse Methods: - client.admin.organization.projects.roles.create(projectID, { ...params }) -> Role - client.admin.organization.projects.roles.retrieve(roleID, { ...params }) -> Role - client.admin.organization.projects.roles.update(roleID, { ...params }) -> Role - client.admin.organization.projects.roles.list(projectID, { ...params }) -> RolesPage - client.admin.organization.projects.roles.delete(roleID, { ...params }) -> RoleDeleteResponse #### DataRetention Types: - ProjectDataRetention Methods: - client.admin.organization.projects.dataRetention.retrieve(projectID) -> ProjectDataRetention - client.admin.organization.projects.dataRetention.update(projectID, { ...params }) -> ProjectDataRetention #### SpendLimit Types: - ProjectSpendLimit - ProjectSpendLimitDeleted Methods: - client.admin.organization.projects.spendLimit.retrieve(projectID) -> ProjectSpendLimit - client.admin.organization.projects.spendLimit.update(projectID, { ...params }) -> ProjectSpendLimit - client.admin.organization.projects.spendLimit.delete(projectID) -> ProjectSpendLimitDeleted #### SpendAlerts Types: - ProjectSpendAlert - ProjectSpendAlertDeleted Methods: - client.admin.organization.projects.spendAlerts.create(projectID, { ...params }) -> ProjectSpendAlert - client.admin.organization.projects.spendAlerts.retrieve(alertID, { ...params }) -> ProjectSpendAlert - client.admin.organization.projects.spendAlerts.update(alertID, { ...params }) -> ProjectSpendAlert - client.admin.organization.projects.spendAlerts.list(projectID, { ...params }) -> ProjectSpendAlertsPage - client.admin.organization.projects.spendAlerts.delete(alertID, { ...params }) -> ProjectSpendAlertDeleted #### Certificates Types: - CertificateListResponse - CertificateActivateResponse - CertificateDeactivateResponse Methods: - client.admin.organization.projects.certificates.list(projectID, { ...params }) -> CertificateListResponsesPage - client.admin.organization.projects.certificates.activate(projectID, { ...params }) -> CertificateActivateResponsesPage - client.admin.organization.projects.certificates.deactivate(projectID, { ...params }) -> CertificateDeactivateResponsesPage # [Responses](src/resources/responses/api.md) # [Live](src/resources/live/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