Skip to content

caffeinelabs/openai-client

BranchesTags

Repository files navigation

OpenAI API

The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.

This Motoko client was generated by the OpenAPI Generator project.

  • API version: 2.3.0
  • Generator version: 7.22.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.MotokoClientCodegen

API Subset

This package ships a curated subset of the upstream OpenAPI surface. Only the following APIs are included; models are kept for them transitively, and any others have been pruned:

  • Chat
  • Completions
  • Models
  • Embeddings
  • Images
  • Audio
  • Moderations
  • Files

Models

  • AdminApiKey
  • AdminApiKeyOwner
  • AdminApiKeysCreateRequest
  • AdminApiKeysDelete200Response
  • AdminApiKeysListOrderParameter
  • Annotation
  • ApiKeyList
  • ApproximateLocation
  • ApproximateLocationType
  • ArrayOfContentPartsInner
  • AssistantMessageWeight
  • AssistantObject
  • AssistantObjectObject
  • AssistantObjectToolResources
  • AssistantObjectToolResourcesCodeInterpreter
  • AssistantObjectToolResourcesFileSearch
  • AssistantObjectToolsInner
  • AssistantStreamEvent
  • AssistantSupportedModels
  • AssistantToolsCode
  • AssistantToolsCodeType
  • AssistantToolsFileSearch
  • AssistantToolsFileSearchFileSearch
  • AssistantToolsFileSearchType
  • AssistantToolsFileSearchTypeOnly
  • AssistantToolsFunction
  • AssistantToolsFunctionType
  • AssistantsApiResponseFormatOption
  • AssistantsApiResponseFormatOptionOneOf
  • AssistantsApiToolChoiceOption
  • AssistantsApiToolChoiceOptionOneOf
  • AssistantsNamedToolChoice
  • AssistantsNamedToolChoiceFunction
  • AssistantsNamedToolChoiceType
  • AudioResponseFormat
  • AuditLog
  • AuditLogActor
  • AuditLogActorApiKey
  • AuditLogActorApiKeyType
  • AuditLogActorServiceAccount
  • AuditLogActorSession
  • AuditLogActorType
  • AuditLogActorUser
  • AuditLogApiKeyCreated
  • AuditLogApiKeyCreatedData
  • AuditLogApiKeyDeleted
  • AuditLogApiKeyUpdated
  • AuditLogApiKeyUpdatedChangesRequested
  • AuditLogCertificateCreated
  • AuditLogCertificateDeleted
  • AuditLogCertificatesActivated
  • AuditLogCertificatesActivatedCertificatesInner
  • AuditLogCheckpointPermissionCreated
  • AuditLogCheckpointPermissionCreatedData
  • AuditLogCheckpointPermissionDeleted
  • AuditLogEventType
  • AuditLogInviteAccepted
  • AuditLogInviteSent
  • AuditLogInviteSentData
  • AuditLogLoginFailed
  • AuditLogOrganizationUpdated
  • AuditLogOrganizationUpdatedChangesRequested
  • AuditLogOrganizationUpdatedChangesRequestedSettings
  • AuditLogProject
  • AuditLogProjectArchived
  • AuditLogProjectCreated
  • AuditLogProjectCreatedData
  • AuditLogProjectUpdated
  • AuditLogProjectUpdatedChangesRequested
  • AuditLogRateLimitDeleted
  • AuditLogRateLimitUpdated
  • AuditLogRateLimitUpdatedChangesRequested
  • AuditLogServiceAccountCreated
  • AuditLogServiceAccountCreatedData
  • AuditLogServiceAccountDeleted
  • AuditLogServiceAccountUpdated
  • AuditLogServiceAccountUpdatedChangesRequested
  • AuditLogUserAdded
  • AuditLogUserAddedData
  • AuditLogUserDeleted
  • AuditLogUserUpdated
  • AuditLogUserUpdatedChangesRequested
  • AutoChunkingStrategy
  • AutoChunkingStrategyRequestParam
  • AutoChunkingStrategyRequestParamType
  • Batch
  • BatchErrors
  • BatchErrorsDataInner
  • BatchObject
  • BatchRequestCounts
  • BatchRequestInput
  • BatchRequestInputMethod
  • BatchRequestOutput
  • BatchRequestOutputError
  • BatchRequestOutputResponse
  • BatchStatus
  • Certificate
  • CertificateCertificateDetails
  • CertificateObject
  • ChatCompletionDeleted
  • ChatCompletionDeletedObject
  • ChatCompletionFunctionCallOption
  • ChatCompletionFunctions
  • ChatCompletionList
  • ChatCompletionListObject
  • ChatCompletionMessageList
  • ChatCompletionMessageListDataInner
  • ChatCompletionMessageToolCall
  • ChatCompletionMessageToolCallChunk
  • ChatCompletionMessageToolCallChunkFunction
  • ChatCompletionMessageToolCallFunction
  • ChatCompletionMessageToolCallType
  • ChatCompletionModalitiesInner
  • ChatCompletionNamedToolChoice
  • ChatCompletionRequestAssistantMessage
  • ChatCompletionRequestAssistantMessageAudio
  • ChatCompletionRequestAssistantMessageContent
  • ChatCompletionRequestAssistantMessageContentPart
  • ChatCompletionRequestAssistantMessageFunctionCall
  • ChatCompletionRequestAssistantMessageRole
  • ChatCompletionRequestDeveloperMessage
  • ChatCompletionRequestDeveloperMessageContent
  • ChatCompletionRequestDeveloperMessageRole
  • ChatCompletionRequestFunctionMessage
  • ChatCompletionRequestFunctionMessageRole
  • ChatCompletionRequestMessage
  • ChatCompletionRequestMessageContentPartAudio
  • ChatCompletionRequestMessageContentPartAudioInputAudio
  • ChatCompletionRequestMessageContentPartAudioInputAudioFormat
  • ChatCompletionRequestMessageContentPartAudioType
  • ChatCompletionRequestMessageContentPartFile
  • ChatCompletionRequestMessageContentPartFileFile
  • ChatCompletionRequestMessageContentPartFileType
  • ChatCompletionRequestMessageContentPartImage
  • ChatCompletionRequestMessageContentPartImageImageUrl
  • ChatCompletionRequestMessageContentPartImageImageUrlDetail
  • ChatCompletionRequestMessageContentPartImageType
  • ChatCompletionRequestMessageContentPartRefusal
  • ChatCompletionRequestMessageContentPartRefusalType
  • ChatCompletionRequestMessageContentPartText
  • ChatCompletionRequestMessageContentPartTextType
  • ChatCompletionRequestSystemMessage
  • ChatCompletionRequestSystemMessageContent
  • ChatCompletionRequestSystemMessageRole
  • ChatCompletionRequestToolMessage
  • ChatCompletionRequestToolMessageContent
  • ChatCompletionRequestToolMessageRole
  • ChatCompletionRequestUserMessage
  • ChatCompletionRequestUserMessageContent
  • ChatCompletionRequestUserMessageContentPart
  • ChatCompletionRequestUserMessageRole
  • ChatCompletionResponseMessage
  • ChatCompletionResponseMessageAnnotationsInner
  • ChatCompletionResponseMessageAnnotationsInnerType
  • ChatCompletionResponseMessageAnnotationsInnerUrlCitation
  • ChatCompletionResponseMessageAudio
  • ChatCompletionResponseMessageFunctionCall
  • ChatCompletionResponseMessageRole
  • ChatCompletionRole
  • ChatCompletionStreamOptions
  • ChatCompletionStreamResponseDelta
  • ChatCompletionStreamResponseDeltaFunctionCall
  • ChatCompletionStreamResponseDeltaRole
  • ChatCompletionTokenLogprob
  • ChatCompletionTokenLogprobTopLogprobsInner
  • ChatCompletionTool
  • ChatCompletionToolChoiceOption
  • ChatCompletionToolChoiceOptionOneOf
  • ChatMessage
  • ChunkingStrategyRequestParam
  • Click
  • ClickButton
  • ClickType
  • CodeInterpreterFileOutput
  • CodeInterpreterFileOutputFilesInner
  • CodeInterpreterFileOutputType
  • CodeInterpreterTextOutput
  • CodeInterpreterTextOutputType
  • CodeInterpreterToolCall
  • CodeInterpreterToolCallStatus
  • CodeInterpreterToolCallType
  • CodeInterpreterToolOutput
  • ComparisonFilter
  • ComparisonFilterType
  • ComparisonFilterValue
  • CompleteUploadRequest
  • CompletionUsage
  • CompletionUsageCompletionTokensDetails
  • CompletionUsagePromptTokensDetails
  • CompoundFilter
  • CompoundFilterFiltersInner
  • CompoundFilterType
  • ComputerAction
  • ComputerCallOutputItemParam
  • ComputerCallOutputItemParamStatus
  • ComputerCallOutputItemParamType
  • ComputerCallSafetyCheckParam
  • ComputerScreenshotImage
  • ComputerScreenshotImageType
  • ComputerToolCall
  • ComputerToolCallOutput
  • ComputerToolCallOutputResource
  • ComputerToolCallOutputStatus
  • ComputerToolCallOutputType
  • ComputerToolCallSafetyCheck
  • ComputerToolCallStatus
  • ComputerToolCallType
  • ComputerUsePreviewTool
  • ComputerUsePreviewToolEnvironment
  • ComputerUsePreviewToolType
  • Content
  • Coordinate
  • CostsResult
  • CostsResultAmount
  • CostsResultObject
  • CreateAssistantRequest
  • CreateAssistantRequestModel
  • CreateAssistantRequestToolResources
  • CreateAssistantRequestToolResourcesCodeInterpreter
  • CreateAssistantRequestToolResourcesFileSearch
  • CreateAssistantRequestToolResourcesFileSearchVectorStoresInner
  • CreateAssistantRequestToolResourcesFileSearchVectorStoresInnerChunkingStrategy
  • CreateBatchRequest
  • CreateBatchRequestCompletionWindow
  • CreateBatchRequestEndpoint
  • CreateChatCompletionRequest
  • CreateChatCompletionRequestAllOfAudio
  • CreateChatCompletionRequestAllOfFunctionCall
  • CreateChatCompletionRequestAllOfFunctionCallOneOf
  • CreateChatCompletionRequestAllOfResponseFormat
  • CreateChatCompletionResponse
  • CreateChatCompletionResponseChoicesInner
  • CreateChatCompletionResponseChoicesInnerFinishReason
  • CreateChatCompletionResponseChoicesInnerLogprobs
  • CreateChatCompletionResponseObject
  • CreateChatCompletionStreamResponse
  • CreateChatCompletionStreamResponseChoicesInner
  • CreateChatCompletionStreamResponseChoicesInnerFinishReason
  • CreateChatCompletionStreamResponseObject
  • CreateCompletionRequest
  • CreateCompletionRequestModel
  • CreateCompletionRequestModelAnyOf
  • CreateCompletionRequestPrompt
  • CreateCompletionResponse
  • CreateCompletionResponseChoicesInner
  • CreateCompletionResponseChoicesInnerFinishReason
  • CreateCompletionResponseChoicesInnerLogprobs
  • CreateCompletionResponseObject
  • CreateEmbeddingRequest
  • CreateEmbeddingRequestEncodingFormat
  • CreateEmbeddingRequestInput
  • CreateEmbeddingRequestModel
  • CreateEmbeddingRequestModelAnyOf
  • CreateEmbeddingResponse
  • CreateEmbeddingResponseObject
  • CreateEmbeddingResponseUsage
  • CreateEvalCompletionsRunDataSource
  • CreateEvalCompletionsRunDataSourceInputMessages
  • CreateEvalCompletionsRunDataSourceSamplingParams
  • CreateEvalCompletionsRunDataSourceSource
  • CreateEvalCompletionsRunDataSourceType
  • CreateEvalCustomDataSourceConfig
  • CreateEvalCustomDataSourceConfigType
  • CreateEvalItem
  • CreateEvalJsonlRunDataSource
  • CreateEvalJsonlRunDataSourceSource
  • CreateEvalJsonlRunDataSourceType
  • CreateEvalLabelModelGrader
  • CreateEvalLabelModelGraderType
  • CreateEvalLogsDataSourceConfig
  • CreateEvalLogsDataSourceConfigType
  • CreateEvalRequest
  • CreateEvalRequestDataSourceConfig
  • CreateEvalRequestTestingCriteriaInner
  • CreateEvalResponsesRunDataSource
  • CreateEvalResponsesRunDataSourceInputMessages
  • CreateEvalResponsesRunDataSourceInputMessagesOneOf
  • CreateEvalResponsesRunDataSourceInputMessagesOneOf1
  • CreateEvalResponsesRunDataSourceInputMessagesOneOfTemplateInner
  • CreateEvalResponsesRunDataSourceSource
  • CreateEvalRunRequest
  • CreateEvalRunRequestDataSource
  • CreateFileRequestPurpose
  • CreateFineTuningCheckpointPermissionRequest
  • CreateFineTuningJobRequest
  • CreateFineTuningJobRequestHyperparameters
  • CreateFineTuningJobRequestHyperparametersBatchSize
  • CreateFineTuningJobRequestHyperparametersBatchSizeOneOf
  • CreateFineTuningJobRequestHyperparametersLearningRateMultiplier
  • CreateFineTuningJobRequestHyperparametersNEpochs
  • CreateFineTuningJobRequestIntegrationsInner
  • CreateFineTuningJobRequestIntegrationsInnerType
  • CreateFineTuningJobRequestIntegrationsInnerWandb
  • CreateFineTuningJobRequestModel
  • CreateFineTuningJobRequestModelAnyOf
  • CreateImageEditRequestImage
  • CreateImageEditRequestModel
  • CreateImageEditRequestModelAnyOf
  • CreateImageEditRequestQuality
  • CreateImageEditRequestResponseFormat
  • CreateImageEditRequestSize
  • CreateImageRequest
  • CreateImageRequestBackground
  • CreateImageRequestModel
  • CreateImageRequestModelAnyOf
  • CreateImageRequestModeration
  • CreateImageRequestOutputFormat
  • CreateImageRequestQuality
  • CreateImageRequestResponseFormat
  • CreateImageRequestSize
  • CreateImageRequestStyle
  • CreateImageVariationRequestModel
  • CreateImageVariationRequestModelAnyOf
  • CreateImageVariationRequestResponseFormat
  • CreateImageVariationRequestSize
  • CreateMessageRequest
  • CreateMessageRequestAttachmentsInner
  • CreateMessageRequestAttachmentsInnerToolsInner
  • CreateMessageRequestContent
  • CreateMessageRequestRole
  • CreateModelResponseProperties
  • CreateModerationRequest
  • CreateModerationRequestInput
  • CreateModerationRequestInputOneOfInner
  • CreateModerationRequestInputOneOfInnerOneOf
  • CreateModerationRequestInputOneOfInnerOneOf1
  • CreateModerationRequestInputOneOfInnerOneOf1Type
  • CreateModerationRequestInputOneOfInnerOneOfImageUrl
  • CreateModerationRequestInputOneOfInnerOneOfType
  • CreateModerationRequestModel
  • CreateModerationRequestModelAnyOf
  • CreateModerationResponse
  • CreateModerationResponseResultsInner
  • CreateModerationResponseResultsInnerCategories
  • CreateModerationResponseResultsInnerCategoryAppliedInputTypes
  • CreateModerationResponseResultsInnerCategoryAppliedInputTypesHateInner
  • CreateModerationResponseResultsInnerCategoryAppliedInputTypesSelfHarmInner
  • CreateModerationResponseResultsInnerCategoryScores
  • CreateResponse
  • CreateResponseAllOfInput
  • CreateRunIncludeParameterInner
  • CreateRunRequest
  • CreateRunRequestModel
  • CreateSpeechRequest
  • CreateSpeechRequestModel
  • CreateSpeechRequestModelAnyOf
  • CreateSpeechRequestResponseFormat
  • CreateThreadAndRunRequest
  • CreateThreadAndRunRequestModel
  • CreateThreadAndRunRequestModelAnyOf
  • CreateThreadAndRunRequestToolResources
  • CreateThreadRequest
  • CreateThreadRequestToolResources
  • CreateThreadRequestToolResourcesFileSearch
  • CreateTranscription200Response
  • CreateTranscriptionRequestModel
  • CreateTranscriptionRequestModelAnyOf
  • CreateTranscriptionRequestTimestampGranularitiesInner
  • CreateTranscriptionResponseJson
  • CreateTranscriptionResponseJsonLogprobsInner
  • CreateTranscriptionResponseStreamEvent
  • CreateTranscriptionResponseVerboseJson
  • CreateTranslation200Response
  • CreateTranslationRequestModel
  • CreateTranslationRequestModelAnyOf
  • CreateTranslationRequestResponseFormat
  • CreateTranslationResponseJson
  • CreateTranslationResponseVerboseJson
  • CreateUploadRequest
  • CreateUploadRequestPurpose
  • CreateVectorStoreFileBatchRequest
  • CreateVectorStoreFileRequest
  • CreateVectorStoreRequest
  • CreateVectorStoreRequestChunkingStrategy
  • DeleteAssistantResponse
  • DeleteAssistantResponseObject
  • DeleteCertificateResponse
  • DeleteCertificateResponseObject
  • DeleteEval200Response
  • DeleteEvalRun200Response
  • DeleteFileResponse
  • DeleteFileResponseObject
  • DeleteFineTuningCheckpointPermissionResponse
  • DeleteFineTuningCheckpointPermissionResponseObject
  • DeleteMessageResponse
  • DeleteMessageResponseObject
  • DeleteModelResponse
  • DeleteThreadResponse
  • DeleteThreadResponseObject
  • DeleteVectorStoreFileResponse
  • DeleteVectorStoreFileResponseObject
  • DeleteVectorStoreResponse
  • DeleteVectorStoreResponseObject
  • DoneEvent
  • DoneEventData
  • DoneEventEvent
  • DoubleClick
  • DoubleClickType
  • Drag
  • DragType
  • EasyInputMessage
  • EasyInputMessageContent
  • EasyInputMessageRole
  • EasyInputMessageType
  • Embedding
  • EmbeddingObject
  • ErrorEvent
  • ErrorEventEvent
  • ErrorResponse
  • Error_
  • Eval
  • EvalApiError
  • EvalCustomDataSourceConfig
  • EvalDataSourceConfig
  • EvalItem
  • EvalItemContent
  • EvalJsonlFileContentSource
  • EvalJsonlFileContentSourceContentInner
  • EvalJsonlFileContentSourceType
  • EvalJsonlFileIdSource
  • EvalJsonlFileIdSourceType
  • EvalLabelModelGrader
  • EvalList
  • EvalObject
  • EvalPythonGrader
  • EvalPythonGraderType
  • EvalResponsesSource
  • EvalResponsesSourceType
  • EvalRun
  • EvalRunDataSource
  • EvalRunList
  • EvalRunObject
  • EvalRunOutputItem
  • EvalRunOutputItemList
  • EvalRunOutputItemObject
  • EvalRunOutputItemSample
  • EvalRunOutputItemSampleInputInner
  • EvalRunOutputItemSampleOutputInner
  • EvalRunOutputItemSampleUsage
  • EvalRunPerModelUsageInner
  • EvalRunPerTestingCriteriaResultsInner
  • EvalRunResultCounts
  • EvalScoreModelGrader
  • EvalScoreModelGraderType
  • EvalStoredCompletionsDataSourceConfig
  • EvalStoredCompletionsDataSourceConfigType
  • EvalStoredCompletionsSource
  • EvalStoredCompletionsSourceType
  • EvalStringCheckGrader
  • EvalStringCheckGraderOperation
  • EvalStringCheckGraderType
  • EvalTestingCriteriaInner
  • EvalTextSimilarityGrader
  • EvalTextSimilarityGraderEvaluationMetric
  • EvalTextSimilarityGraderType
  • FileCitationBody
  • FileCitationBodyType
  • FilePath
  • FilePathType
  • FileSearchRanker
  • FileSearchRankingOptions
  • FileSearchTool
  • FileSearchToolCall
  • FileSearchToolCallResultsInner
  • FileSearchToolCallStatus
  • FileSearchToolCallType
  • FileSearchToolType
  • Filters
  • FineTuneChatCompletionRequestAssistantMessage
  • FineTuneChatRequestInput
  • FineTuneChatRequestInputMessagesInner
  • FineTuneCompletionRequestInput
  • FineTuneDPOMethod
  • FineTuneDPOMethodHyperparameters
  • FineTuneDPOMethodHyperparametersBatchSize
  • FineTuneDPOMethodHyperparametersBeta
  • FineTuneDPOMethodHyperparametersLearningRateMultiplier
  • FineTuneDPOMethodHyperparametersNEpochs
  • FineTuneMethod
  • FineTuneMethodType
  • FineTunePreferenceRequestInput
  • FineTunePreferenceRequestInputInput
  • FineTunePreferenceRequestInputPreferredCompletionInner
  • FineTuneSupervisedMethod
  • FineTuneSupervisedMethodHyperparameters
  • FineTuningCheckpointPermission
  • FineTuningIntegration
  • FineTuningIntegrationType
  • FineTuningJob
  • FineTuningJobCheckpoint
  • FineTuningJobCheckpointMetrics
  • FineTuningJobCheckpointObject
  • FineTuningJobError
  • FineTuningJobEvent
  • FineTuningJobEventLevel
  • FineTuningJobEventObject
  • FineTuningJobEventType
  • FineTuningJobHyperparameters
  • FineTuningJobIntegrationsInner
  • FineTuningJobObject
  • FineTuningJobStatus
  • FunctionCallOutputItemParam
  • FunctionCallOutputItemParamStatus
  • FunctionCallOutputItemParamType
  • FunctionObject
  • FunctionTool
  • FunctionToolCall
  • FunctionToolCallOutput
  • FunctionToolCallOutputResource
  • FunctionToolCallOutputType
  • FunctionToolCallResource
  • FunctionToolCallType
  • FunctionToolType
  • GetCertificateIncludeParameterInner
  • GetEvalRunOutputItemsStatusParameter
  • GetEvalRunsStatusParameter
  • Image
  • ImagesResponse
  • ImagesResponseUsage
  • ImagesResponseUsageInputTokensDetails
  • Includable
  • InputAudio
  • InputAudioFormat
  • InputAudioType
  • InputContent
  • InputFileContent
  • InputFileContentType
  • InputImageContent
  • InputImageContentDetail
  • InputImageContentType
  • InputItem
  • InputMessage
  • InputMessageResource
  • InputMessageRole
  • InputMessageStatus
  • InputMessageType
  • InputTextContent
  • InputTextContentType
  • Invite
  • InviteDeleteResponse
  • InviteDeleteResponseObject
  • InviteListResponse
  • InviteListResponseObject
  • InviteObject
  • InviteProjectsInner
  • InviteProjectsInnerRole
  • InviteRequest
  • InviteRequestProjectsInner
  • InviteRequestRole
  • InviteRole
  • InviteStatus
  • Item
  • ItemReferenceInputMessages
  • ItemReferenceInputMessagesType
  • ItemReferenceParam
  • ItemReferenceParamType
  • ItemResource
  • JSONSchema
  • KeyPress
  • KeyPressType
  • ListAssistantsOrderParameter
  • ListAssistantsResponse
  • ListAuditLogsEffectiveAtParameter
  • ListAuditLogsResponse
  • ListAuditLogsResponseObject
  • ListBatchesResponse
  • ListCertificatesResponse
  • ListChatCompletionsOrderParameter
  • ListEvalsOrderByParameter
  • ListFilesInVectorStoreBatchFilterParameter
  • ListFilesResponse
  • ListFineTuningCheckpointPermissionResponse
  • ListFineTuningCheckpointPermissionsOrderParameter
  • ListFineTuningJobCheckpointsResponse
  • ListFineTuningJobEventsResponse
  • ListInputItemsOrderParameter
  • ListMessagesResponse
  • ListModelsResponse
  • ListPaginatedFineTuningJobsResponse
  • ListRunStepsResponse
  • ListRunsResponse
  • ListVectorStoreFilesResponse
  • ListVectorStoresResponse
  • LogProbProperties
  • MessageContentImageFileObject
  • MessageContentImageFileObjectImageFile
  • MessageContentImageFileObjectImageFileDetail
  • MessageContentImageFileObjectType
  • MessageContentImageUrlObject
  • MessageContentImageUrlObjectImageUrl
  • MessageContentImageUrlObjectImageUrlDetail
  • MessageContentRefusalObject
  • MessageContentRefusalObjectType
  • MessageContentTextAnnotationsFileCitationObject
  • MessageContentTextAnnotationsFileCitationObjectFileCitation
  • MessageContentTextAnnotationsFileCitationObjectType
  • MessageContentTextAnnotationsFilePathObject
  • MessageContentTextAnnotationsFilePathObjectFilePath
  • MessageContentTextAnnotationsFilePathObjectType
  • MessageContentTextObject
  • MessageContentTextObjectText
  • MessageContentTextObjectTextAnnotationsInner
  • MessageDeltaContentImageFileObject
  • MessageDeltaContentImageFileObjectImageFile
  • MessageDeltaContentImageUrlObject
  • MessageDeltaContentImageUrlObjectImageUrl
  • MessageDeltaContentImageUrlObjectImageUrlDetail
  • MessageDeltaContentRefusalObject
  • MessageDeltaContentTextAnnotationsFileCitationObject
  • MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation
  • MessageDeltaContentTextAnnotationsFilePathObject
  • MessageDeltaContentTextAnnotationsFilePathObjectFilePath
  • MessageDeltaContentTextObject
  • MessageDeltaContentTextObjectText
  • MessageDeltaContentTextObjectTextAnnotationsInner
  • MessageDeltaObject
  • MessageDeltaObjectDelta
  • MessageDeltaObjectDeltaContentInner
  • MessageDeltaObjectDeltaRole
  • MessageDeltaObjectObject
  • MessageObject
  • MessageObjectContentInner
  • MessageObjectIncompleteDetails
  • MessageObjectIncompleteDetailsReason
  • MessageObjectObject
  • MessageObjectStatus
  • MessageRequestContentTextObject
  • MessageStreamEvent
  • MessageStreamEventOneOf
  • MessageStreamEventOneOf1
  • MessageStreamEventOneOf1Event
  • MessageStreamEventOneOf2
  • MessageStreamEventOneOf2Event
  • MessageStreamEventOneOf3
  • MessageStreamEventOneOf3Event
  • MessageStreamEventOneOf4
  • MessageStreamEventOneOf4Event
  • MessageStreamEventOneOfEvent
  • Model
  • ModelIds
  • ModelIdsResponses
  • ModelIdsShared
  • ModelIdsSharedAnyOf
  • ModelObject
  • ModelResponseProperties
  • ModifyAssistantRequest
  • ModifyAssistantRequestModel
  • ModifyAssistantRequestToolResources
  • ModifyAssistantRequestToolResourcesCodeInterpreter
  • ModifyAssistantRequestToolResourcesFileSearch
  • ModifyCertificateRequest
  • ModifyMessageRequest
  • ModifyRunRequest
  • ModifyThreadRequest
  • ModifyThreadRequestToolResources
  • ModifyThreadRequestToolResourcesFileSearch
  • Move
  • MoveType
  • OpenAIFile
  • OpenAIFileObject
  • OpenAIFilePurpose
  • OpenAIFileStatus
  • OtherChunkingStrategyResponseParam
  • OtherChunkingStrategyResponseParamType
  • OutputAudio
  • OutputAudioType
  • OutputContent
  • OutputItem
  • OutputMessage
  • OutputMessageRole
  • OutputMessageType
  • OutputText
  • OutputTextContent
  • OutputTextContentType
  • OutputTextType
  • PredictionContent
  • PredictionContentContent
  • PredictionContentType
  • Project
  • ProjectApiKey
  • ProjectApiKeyDeleteResponse
  • ProjectApiKeyDeleteResponseObject
  • ProjectApiKeyListResponse
  • ProjectApiKeyObject
  • ProjectApiKeyOwner
  • ProjectApiKeyOwnerType
  • ProjectCreateRequest
  • ProjectListResponse
  • ProjectObject
  • ProjectRateLimit
  • ProjectRateLimitListResponse
  • ProjectRateLimitObject
  • ProjectRateLimitUpdateRequest
  • ProjectServiceAccount
  • ProjectServiceAccountApiKey
  • ProjectServiceAccountApiKeyObject
  • ProjectServiceAccountCreateRequest
  • ProjectServiceAccountCreateResponse
  • ProjectServiceAccountCreateResponseObject
  • ProjectServiceAccountCreateResponseRole
  • ProjectServiceAccountDeleteResponse
  • ProjectServiceAccountDeleteResponseObject
  • ProjectServiceAccountListResponse
  • ProjectServiceAccountObject
  • ProjectServiceAccountRole
  • ProjectStatus
  • ProjectUpdateRequest
  • ProjectUser
  • ProjectUserCreateRequest
  • ProjectUserDeleteResponse
  • ProjectUserDeleteResponseObject
  • ProjectUserListResponse
  • ProjectUserObject
  • ProjectUserUpdateRequest
  • RankingOptions
  • RankingOptionsRanker
  • RealtimeClientEvent
  • RealtimeClientEventConversationItemCreate
  • RealtimeClientEventConversationItemCreateType
  • RealtimeClientEventConversationItemDelete
  • RealtimeClientEventConversationItemDeleteType
  • RealtimeClientEventConversationItemRetrieve
  • RealtimeClientEventConversationItemRetrieveType
  • RealtimeClientEventConversationItemTruncate
  • RealtimeClientEventConversationItemTruncateType
  • RealtimeClientEventInputAudioBufferAppend
  • RealtimeClientEventInputAudioBufferAppendType
  • RealtimeClientEventInputAudioBufferClear
  • RealtimeClientEventInputAudioBufferClearType
  • RealtimeClientEventInputAudioBufferCommit
  • RealtimeClientEventInputAudioBufferCommitType
  • RealtimeClientEventOutputAudioBufferClear
  • RealtimeClientEventOutputAudioBufferClearType
  • RealtimeClientEventResponseCancel
  • RealtimeClientEventResponseCancelType
  • RealtimeClientEventResponseCreate
  • RealtimeClientEventResponseCreateType
  • RealtimeClientEventSessionUpdate
  • RealtimeClientEventSessionUpdateType
  • RealtimeClientEventTranscriptionSessionUpdate
  • RealtimeClientEventTranscriptionSessionUpdateType
  • RealtimeConversationItem
  • RealtimeConversationItemContentInner
  • RealtimeConversationItemContentInnerType
  • RealtimeConversationItemObject
  • RealtimeConversationItemRole
  • RealtimeConversationItemStatus
  • RealtimeConversationItemType
  • RealtimeConversationItemWithReference
  • RealtimeConversationItemWithReferenceType
  • RealtimeResponse
  • RealtimeResponseCreateParams
  • RealtimeResponseCreateParamsConversation
  • RealtimeResponseCreateParamsConversationOneOf
  • RealtimeResponseCreateParamsMaxResponseOutputTokens
  • RealtimeResponseCreateParamsToolsInner
  • RealtimeResponseCreateParamsToolsInnerType
  • RealtimeResponseMaxOutputTokens
  • RealtimeResponseMaxOutputTokensOneOf
  • RealtimeResponseObject
  • RealtimeResponseOutputAudioFormat
  • RealtimeResponseStatus
  • RealtimeResponseStatusDetails
  • RealtimeResponseStatusDetailsError
  • RealtimeResponseStatusDetailsReason
  • RealtimeResponseStatusDetailsType
  • RealtimeResponseUsage
  • RealtimeResponseUsageInputTokenDetails
  • RealtimeResponseUsageOutputTokenDetails
  • RealtimeServerEvent
  • RealtimeServerEventConversationCreated
  • RealtimeServerEventConversationCreatedConversation
  • RealtimeServerEventConversationCreatedType
  • RealtimeServerEventConversationItemCreated
  • RealtimeServerEventConversationItemCreatedType
  • RealtimeServerEventConversationItemDeleted
  • RealtimeServerEventConversationItemDeletedType
  • RealtimeServerEventConversationItemInputAudioTranscriptionCompleted
  • RealtimeServerEventConversationItemInputAudioTranscriptionCompletedType
  • RealtimeServerEventConversationItemInputAudioTranscriptionDelta
  • RealtimeServerEventConversationItemInputAudioTranscriptionDeltaType
  • RealtimeServerEventConversationItemInputAudioTranscriptionFailed
  • RealtimeServerEventConversationItemInputAudioTranscriptionFailedError
  • RealtimeServerEventConversationItemInputAudioTranscriptionFailedType
  • RealtimeServerEventConversationItemRetrieved
  • RealtimeServerEventConversationItemRetrievedType
  • RealtimeServerEventConversationItemTruncated
  • RealtimeServerEventConversationItemTruncatedType
  • RealtimeServerEventError
  • RealtimeServerEventErrorError
  • RealtimeServerEventErrorType
  • RealtimeServerEventInputAudioBufferCleared
  • RealtimeServerEventInputAudioBufferClearedType
  • RealtimeServerEventInputAudioBufferCommitted
  • RealtimeServerEventInputAudioBufferCommittedType
  • RealtimeServerEventInputAudioBufferSpeechStarted
  • RealtimeServerEventInputAudioBufferSpeechStartedType
  • RealtimeServerEventInputAudioBufferSpeechStopped
  • RealtimeServerEventInputAudioBufferSpeechStoppedType
  • RealtimeServerEventOutputAudioBufferCleared
  • RealtimeServerEventOutputAudioBufferClearedType
  • RealtimeServerEventOutputAudioBufferStarted
  • RealtimeServerEventOutputAudioBufferStartedType
  • RealtimeServerEventOutputAudioBufferStopped
  • RealtimeServerEventOutputAudioBufferStoppedType
  • RealtimeServerEventRateLimitsUpdated
  • RealtimeServerEventRateLimitsUpdatedRateLimitsInner
  • RealtimeServerEventRateLimitsUpdatedRateLimitsInnerName
  • RealtimeServerEventRateLimitsUpdatedType
  • RealtimeServerEventResponseAudioDelta
  • RealtimeServerEventResponseAudioDeltaType
  • RealtimeServerEventResponseAudioDone
  • RealtimeServerEventResponseAudioDoneType
  • RealtimeServerEventResponseAudioTranscriptDelta
  • RealtimeServerEventResponseAudioTranscriptDeltaType
  • RealtimeServerEventResponseAudioTranscriptDone
  • RealtimeServerEventResponseAudioTranscriptDoneType
  • RealtimeServerEventResponseContentPartAdded
  • RealtimeServerEventResponseContentPartAddedPart
  • RealtimeServerEventResponseContentPartAddedPartType
  • RealtimeServerEventResponseContentPartAddedType
  • RealtimeServerEventResponseContentPartDone
  • RealtimeServerEventResponseContentPartDonePart
  • RealtimeServerEventResponseContentPartDoneType
  • RealtimeServerEventResponseCreated
  • RealtimeServerEventResponseCreatedType
  • RealtimeServerEventResponseDone
  • RealtimeServerEventResponseDoneType
  • RealtimeServerEventResponseFunctionCallArgumentsDelta
  • RealtimeServerEventResponseFunctionCallArgumentsDeltaType
  • RealtimeServerEventResponseFunctionCallArgumentsDone
  • RealtimeServerEventResponseFunctionCallArgumentsDoneType
  • RealtimeServerEventResponseOutputItemAdded
  • RealtimeServerEventResponseOutputItemAddedType
  • RealtimeServerEventResponseOutputItemDone
  • RealtimeServerEventResponseOutputItemDoneType
  • RealtimeServerEventResponseTextDelta
  • RealtimeServerEventResponseTextDeltaType
  • RealtimeServerEventResponseTextDone
  • RealtimeServerEventResponseTextDoneType
  • RealtimeServerEventSessionCreated
  • RealtimeServerEventSessionCreatedType
  • RealtimeServerEventSessionUpdated
  • RealtimeServerEventSessionUpdatedType
  • RealtimeServerEventTranscriptionSessionUpdated
  • RealtimeServerEventTranscriptionSessionUpdatedType
  • RealtimeSession
  • RealtimeSessionCreateRequest
  • RealtimeSessionCreateResponse
  • RealtimeSessionCreateResponseClientSecret
  • RealtimeSessionCreateResponseInputAudioTranscription
  • RealtimeSessionCreateResponseTurnDetection
  • RealtimeSessionInputAudioFormat
  • RealtimeSessionInputAudioNoiseReduction
  • RealtimeSessionInputAudioNoiseReductionType
  • RealtimeSessionInputAudioTranscription
  • RealtimeSessionModel
  • RealtimeSessionOutputAudioFormat
  • RealtimeSessionTurnDetection
  • RealtimeSessionTurnDetectionEagerness
  • RealtimeSessionTurnDetectionType
  • RealtimeTranscriptionSessionCreateRequest
  • RealtimeTranscriptionSessionCreateRequestInputAudioTranscription
  • RealtimeTranscriptionSessionCreateRequestInputAudioTranscriptionModel
  • RealtimeTranscriptionSessionCreateRequestTurnDetection
  • RealtimeTranscriptionSessionCreateResponse
  • RealtimeTranscriptionSessionCreateResponseClientSecret
  • RealtimeTranscriptionSessionCreateResponseInputAudioTranscription
  • RealtimeTranscriptionSessionCreateResponseInputAudioTranscriptionModel
  • Reasoning
  • ReasoningEffort
  • ReasoningGenerateSummary
  • ReasoningItem
  • ReasoningItemSummaryInner
  • ReasoningItemSummaryInnerType
  • ReasoningItemType
  • ReasoningSummary
  • RefusalContent
  • RefusalContentType
  • Response
  • ResponseAllOfIncompleteDetails
  • ResponseAllOfObject
  • ResponseAllOfStatus
  • ResponseAudioDeltaEvent
  • ResponseAudioDeltaEventType
  • ResponseAudioDoneEvent
  • ResponseAudioDoneEventType
  • ResponseAudioTranscriptDeltaEvent
  • ResponseAudioTranscriptDeltaEventType
  • ResponseAudioTranscriptDoneEvent
  • ResponseAudioTranscriptDoneEventType
  • ResponseCodeInterpreterCallCodeDeltaEvent
  • ResponseCodeInterpreterCallCodeDeltaEventType
  • ResponseCodeInterpreterCallCodeDoneEvent
  • ResponseCodeInterpreterCallCodeDoneEventType
  • ResponseCodeInterpreterCallCompletedEvent
  • ResponseCodeInterpreterCallCompletedEventType
  • ResponseCodeInterpreterCallInProgressEvent
  • ResponseCodeInterpreterCallInProgressEventType
  • ResponseCodeInterpreterCallInterpretingEvent
  • ResponseCodeInterpreterCallInterpretingEventType
  • ResponseCompletedEvent
  • ResponseCompletedEventType
  • ResponseContentPartAddedEvent
  • ResponseContentPartAddedEventType
  • ResponseContentPartDoneEvent
  • ResponseContentPartDoneEventType
  • ResponseCreatedEvent
  • ResponseCreatedEventType
  • ResponseError
  • ResponseErrorCode
  • ResponseErrorEvent
  • ResponseErrorEventType
  • ResponseFailedEvent
  • ResponseFailedEventType
  • ResponseFileSearchCallCompletedEvent
  • ResponseFileSearchCallCompletedEventType
  • ResponseFileSearchCallInProgressEvent
  • ResponseFileSearchCallInProgressEventType
  • ResponseFileSearchCallSearchingEvent
  • ResponseFileSearchCallSearchingEventType
  • ResponseFormatJsonObject
  • ResponseFormatJsonObjectType
  • ResponseFormatJsonSchema
  • ResponseFormatJsonSchemaType
  • ResponseFormatText
  • ResponseFormatTextType
  • ResponseFunctionCallArgumentsDeltaEvent
  • ResponseFunctionCallArgumentsDeltaEventType
  • ResponseFunctionCallArgumentsDoneEvent
  • ResponseFunctionCallArgumentsDoneEventType
  • ResponseInProgressEvent
  • ResponseInProgressEventType
  • ResponseIncompleteEvent
  • ResponseIncompleteEventType
  • ResponseItemList
  • ResponseItemListObject
  • ResponseOutputItemAddedEvent
  • ResponseOutputItemAddedEventType
  • ResponseOutputItemDoneEvent
  • ResponseOutputItemDoneEventType
  • ResponseProperties
  • ResponsePropertiesText
  • ResponsePropertiesToolChoice
  • ResponsePropertiesTruncation
  • ResponseReasoningSummaryPartAddedEvent
  • ResponseReasoningSummaryPartAddedEventPart
  • ResponseReasoningSummaryPartAddedEventPartType
  • ResponseReasoningSummaryPartAddedEventType
  • ResponseReasoningSummaryPartDoneEvent
  • ResponseReasoningSummaryPartDoneEventPart
  • ResponseReasoningSummaryPartDoneEventType
  • ResponseReasoningSummaryTextDeltaEvent
  • ResponseReasoningSummaryTextDeltaEventType
  • ResponseReasoningSummaryTextDoneEvent
  • ResponseReasoningSummaryTextDoneEventType
  • ResponseRefusalDeltaEvent
  • ResponseRefusalDeltaEventType
  • ResponseRefusalDoneEvent
  • ResponseRefusalDoneEventType
  • ResponseStreamEvent
  • ResponseTextAnnotationDeltaEvent
  • ResponseTextAnnotationDeltaEventType
  • ResponseTextDeltaEvent
  • ResponseTextDeltaEventType
  • ResponseTextDoneEvent
  • ResponseTextDoneEventType
  • ResponseUsage
  • ResponseUsageInputTokensDetails
  • ResponseUsageOutputTokensDetails
  • ResponseWebSearchCallCompletedEvent
  • ResponseWebSearchCallCompletedEventType
  • ResponseWebSearchCallInProgressEvent
  • ResponseWebSearchCallInProgressEventType
  • ResponseWebSearchCallSearchingEvent
  • ResponseWebSearchCallSearchingEventType
  • ResponsesOnlyModel
  • RunCompletionUsage
  • RunObject
  • RunObjectIncompleteDetails
  • RunObjectIncompleteDetailsReason
  • RunObjectLastError
  • RunObjectLastErrorCode
  • RunObjectObject
  • RunObjectRequiredAction
  • RunObjectRequiredActionSubmitToolOutputs
  • RunObjectRequiredActionType
  • RunObjectStatus
  • RunStepCompletionUsage
  • RunStepDeltaObject
  • RunStepDeltaObjectDelta
  • RunStepDeltaObjectDeltaStepDetails
  • RunStepDeltaObjectObject
  • RunStepDeltaStepDetailsMessageCreationObject
  • RunStepDeltaStepDetailsMessageCreationObjectMessageCreation
  • RunStepDeltaStepDetailsMessageCreationObjectType
  • RunStepDeltaStepDetailsToolCallsCodeObject
  • RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreter
  • RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner
  • RunStepDeltaStepDetailsToolCallsCodeObjectType
  • RunStepDeltaStepDetailsToolCallsCodeOutputImageObject
  • RunStepDeltaStepDetailsToolCallsCodeOutputImageObjectImage
  • RunStepDeltaStepDetailsToolCallsCodeOutputImageObjectType
  • RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject
  • RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType
  • RunStepDeltaStepDetailsToolCallsFileSearchObject
  • RunStepDeltaStepDetailsToolCallsFileSearchObjectType
  • RunStepDeltaStepDetailsToolCallsFunctionObject
  • RunStepDeltaStepDetailsToolCallsFunctionObjectFunction
  • RunStepDeltaStepDetailsToolCallsFunctionObjectType
  • RunStepDeltaStepDetailsToolCallsObject
  • RunStepDeltaStepDetailsToolCallsObjectToolCallsInner
  • RunStepDeltaStepDetailsToolCallsObjectType
  • RunStepDetailsMessageCreationObject
  • RunStepDetailsMessageCreationObjectMessageCreation
  • RunStepDetailsToolCallsCodeObject
  • RunStepDetailsToolCallsCodeObjectCodeInterpreter
  • RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner
  • RunStepDetailsToolCallsCodeOutputImageObject
  • RunStepDetailsToolCallsCodeOutputImageObjectImage
  • RunStepDetailsToolCallsCodeOutputLogsObject
  • RunStepDetailsToolCallsFileSearchObject
  • RunStepDetailsToolCallsFileSearchObjectFileSearch
  • RunStepDetailsToolCallsFileSearchRankingOptionsObject
  • RunStepDetailsToolCallsFileSearchResultObject
  • RunStepDetailsToolCallsFileSearchResultObjectContentInner
  • RunStepDetailsToolCallsFileSearchResultObjectContentInnerType
  • RunStepDetailsToolCallsFunctionObject
  • RunStepDetailsToolCallsFunctionObjectFunction
  • RunStepDetailsToolCallsObject
  • RunStepDetailsToolCallsObjectToolCallsInner
  • RunStepObject
  • RunStepObjectLastError
  • RunStepObjectLastErrorCode
  • RunStepObjectObject
  • RunStepObjectStatus
  • RunStepObjectStepDetails
  • RunStepObjectType
  • RunStepStreamEvent
  • RunStepStreamEventOneOf
  • RunStepStreamEventOneOf1
  • RunStepStreamEventOneOf1Event
  • RunStepStreamEventOneOf2
  • RunStepStreamEventOneOf2Event
  • RunStepStreamEventOneOf3
  • RunStepStreamEventOneOf3Event
  • RunStepStreamEventOneOf4
  • RunStepStreamEventOneOf4Event
  • RunStepStreamEventOneOf5
  • RunStepStreamEventOneOf5Event
  • RunStepStreamEventOneOf6
  • RunStepStreamEventOneOf6Event
  • RunStepStreamEventOneOfEvent
  • RunStreamEvent
  • RunStreamEventOneOf
  • RunStreamEventOneOf1
  • RunStreamEventOneOf1Event
  • RunStreamEventOneOf2
  • RunStreamEventOneOf2Event
  • RunStreamEventOneOf3
  • RunStreamEventOneOf3Event
  • RunStreamEventOneOf4
  • RunStreamEventOneOf4Event
  • RunStreamEventOneOf5
  • RunStreamEventOneOf5Event
  • RunStreamEventOneOf6
  • RunStreamEventOneOf6Event
  • RunStreamEventOneOf7
  • RunStreamEventOneOf7Event
  • RunStreamEventOneOf8
  • RunStreamEventOneOf8Event
  • RunStreamEventOneOf9
  • RunStreamEventOneOf9Event
  • RunStreamEventOneOfEvent
  • RunToolCallObject
  • RunToolCallObjectFunction
  • RunToolCallObjectType
  • Screenshot
  • ScreenshotType
  • Scroll
  • ScrollType
  • ServiceTier
  • SimpleInputMessage
  • StaticChunkingStrategy
  • StaticChunkingStrategyRequestParam
  • StaticChunkingStrategyResponseParam
  • StaticChunkingStrategyStatic
  • StaticChunkingStrategyType
  • StopConfiguration
  • SubmitToolOutputsRunRequest
  • SubmitToolOutputsRunRequestToolOutputsInner
  • TemplateInputMessages
  • TemplateInputMessagesTemplateInner
  • TemplateInputMessagesType
  • TextResponseFormatConfiguration
  • TextResponseFormatJsonSchema
  • ThreadObject
  • ThreadObjectObject
  • ThreadStreamEvent
  • ThreadStreamEventEvent
  • ToggleCertificatesRequest
  • Tool
  • ToolChoiceFunction
  • ToolChoiceFunctionType
  • ToolChoiceOptions
  • ToolChoiceTypes
  • ToolChoiceTypesType
  • TranscriptTextDeltaEvent
  • TranscriptTextDeltaEventLogprobsInner
  • TranscriptTextDeltaEventType
  • TranscriptTextDoneEvent
  • TranscriptTextDoneEventType
  • TranscriptionInclude
  • TranscriptionSegment
  • TranscriptionWord
  • TruncationObject
  • TruncationObjectType
  • TypeType
  • Type_
  • UpdateChatCompletionRequest
  • UpdateEvalRequest
  • UpdateVectorStoreFileAttributesRequest
  • UpdateVectorStoreRequest
  • Upload
  • UploadCertificateRequest
  • UploadObject
  • UploadPart
  • UploadPartObject
  • UploadStatus
  • UrlCitationBody
  • UrlCitationBodyType
  • UsageAudioSpeechesBucketWidthParameter
  • UsageAudioSpeechesGroupByParameterInner
  • UsageAudioSpeechesResult
  • UsageAudioSpeechesResultObject
  • UsageAudioTranscriptionsResult
  • UsageAudioTranscriptionsResultObject
  • UsageCodeInterpreterSessionsGroupByParameterInner
  • UsageCodeInterpreterSessionsResult
  • UsageCodeInterpreterSessionsResultObject
  • UsageCompletionsGroupByParameterInner
  • UsageCompletionsResult
  • UsageCompletionsResultObject
  • UsageCostsBucketWidthParameter
  • UsageCostsGroupByParameterInner
  • UsageEmbeddingsResult
  • UsageEmbeddingsResultObject
  • UsageImagesGroupByParameterInner
  • UsageImagesResult
  • UsageImagesResultObject
  • UsageImagesSizesParameterInner
  • UsageImagesSourcesParameterInner
  • UsageModerationsResult
  • UsageModerationsResultObject
  • UsageResponse
  • UsageResponseObject
  • UsageTimeBucket
  • UsageTimeBucketObject
  • UsageTimeBucketResultInner
  • UsageVectorStoresResult
  • UsageVectorStoresResultObject
  • User
  • UserDeleteResponse
  • UserDeleteResponseObject
  • UserListResponse
  • UserObject
  • UserRoleUpdateRequest
  • VectorStoreExpirationAfter
  • VectorStoreExpirationAfterAnchor
  • VectorStoreFileAttributesValue
  • VectorStoreFileBatchObject
  • VectorStoreFileBatchObjectFileCounts
  • VectorStoreFileBatchObjectObject
  • VectorStoreFileBatchObjectStatus
  • VectorStoreFileContentResponse
  • VectorStoreFileContentResponseDataInner
  • VectorStoreFileContentResponseObject
  • VectorStoreFileObject
  • VectorStoreFileObjectChunkingStrategy
  • VectorStoreFileObjectLastError
  • VectorStoreFileObjectLastErrorCode
  • VectorStoreFileObjectObject
  • VectorStoreFileObjectStatus
  • VectorStoreObject
  • VectorStoreObjectFileCounts
  • VectorStoreObjectObject
  • VectorStoreObjectStatus
  • VectorStoreSearchRequest
  • VectorStoreSearchRequestFilters
  • VectorStoreSearchRequestQuery
  • VectorStoreSearchRequestRankingOptions
  • VectorStoreSearchRequestRankingOptionsRanker
  • VectorStoreSearchResultContentObject
  • VectorStoreSearchResultContentObjectType
  • VectorStoreSearchResultItem
  • VectorStoreSearchResultsPage
  • VectorStoreSearchResultsPageObject
  • VoiceIdsShared
  • VoiceIdsSharedAnyOf
  • Wait
  • WaitType
  • WebSearch
  • WebSearchContextSize
  • WebSearchLocation
  • WebSearchPreviewTool
  • WebSearchPreviewToolSearchContextSize
  • WebSearchPreviewToolType
  • WebSearchToolCall
  • WebSearchToolCallStatus
  • WebSearchToolCallType
  • WebSearchUserLocation

APIs

  • AssistantsApi
  • AudioApi
  • AuditLogsApi
  • BatchApi
  • CertificatesApi
  • ChatApi
  • CompletionsApi
  • DefaultApi
  • EmbeddingsApi
  • EvalsApi
  • FilesApi
  • FineTuningApi
  • ImagesApi
  • InvitesApi
  • ModelsApi
  • ModerationsApi
  • ProjectsApi
  • RealtimeApi
  • ResponsesApi
  • UploadsApi
  • UsageApi
  • UsersApi
  • VectorStoresApi

Installation

This is a Motoko module that can be used in your Internet Computer project.

Usage

Import the generated API modules in your Motoko code:

import SomeApi "mo:openai-client/Apis/SomeApi";
// or using destructuring for specific functions
import { someFunction } "mo:openai-client/Apis/SomeApi";

Configure and call the API:

import { defaultConfig } "mo:openai-client/Config";

// Use the default config as-is, or customize specific fields:
let config = { defaultConfig with auth = ?#bearer "my-token" };

let result = await* SomeApi.someFunction(config, ...);

The defaultConfig has baseUrl pre-set to the API's base URL, cycles = 30_000_000_000, and all optional fields set to null.

Alternatively, use the suite-based API to bind config once and call multiple functions without threading it through each call:

import { SomeApi } "mo:openai-client/Apis/SomeApi";

let api = SomeApi(config);
let result = await api.someFunction(...);
let other = await api.anotherFunction(...);

HTTP Outcalls and Cycles

The generated API client makes HTTP outcalls using the Internet Computer's management canister. HTTP outcalls require cycles to execute.

Important: Before calling any API endpoints, ensure your canister has sufficient cycles:

For local development with icp-cli:

icp network start -d    # local replica auto-seeds cycles — no fabrication needed
icp deploy              # build + deploy

For mainnet:

icp cycles balance -n ic   # check balance
icp deploy -e ic           # deploy to mainnet
Legacy: using dfx (sunset)

For local development:

# Get your canister ID
CANISTER_ID=$(dfx canister id your_canister_name)

# Add cycles (100 trillion cycles for testing)
dfx ledger fabricate-cycles --canister "$CANISTER_ID" --amount 100000000000000

For production deployment, you'll need to fund your canister with cycles through the NNS or cycles wallet.

Each HTTP outcall typically costs around 20-50 million cycles depending on the request/response size.

About

Generated Motoko client for OpenAI API

mops.one/openai-client

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 4

openai-client 0.1.3 — serde-core 0.1.1 type-table cycle fix Latest
Apr 27, 2026
+ 3 releases

Packages

 
 
 

Contributors

Languages