The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 2.0.0
- Build package: org.openapitools.codegen.languages.JuliaClientCodegen For more information, please visit https://help.openai.com/
Place the Julia files generated under the src folder in your Julia project. Include OpenAIOpenAPI.jl in the project code.
It would include the module named OpenAIOpenAPI.
Documentation is generated as markdown files under the docs folder. You can include them in your project documentation.
Documentation is also embedded in Julia which can be used with a Julia specific documentation generator.
| Class | Method |
|---|---|
| AssistantsApi | cancel_run POST /threads/{thread_id}/runs/{run_id}/cancel Cancels a run that is `in_progress`. |
| AssistantsApi | create_assistant POST /assistants Create an assistant with a model and instructions. |
| AssistantsApi | create_assistant_file POST /assistants/{assistant_id}/files Create an assistant file by attaching a File to an assistant. |
| AssistantsApi | create_message POST /threads/{thread_id}/messages Create a message. |
| AssistantsApi | create_run POST /threads/{thread_id}/runs Create a run. |
| AssistantsApi | create_thread POST /threads Create a thread. |
| AssistantsApi | create_thread_and_run POST /threads/runs Create a thread and run it in one request. |
| AssistantsApi | delete_assistant DELETE /assistants/{assistant_id} Delete an assistant. |
| AssistantsApi | delete_assistant_file DELETE /assistants/{assistant_id}/files/{file_id} Delete an assistant file. |
| AssistantsApi | delete_thread DELETE /threads/{thread_id} Delete a thread. |
| AssistantsApi | get_assistant GET /assistants/{assistant_id} Retrieves an assistant. |
| AssistantsApi | get_assistant_file GET /assistants/{assistant_id}/files/{file_id} Retrieves an AssistantFile. |
| AssistantsApi | get_message GET /threads/{thread_id}/messages/{message_id} Retrieve a message. |
| AssistantsApi | get_message_file GET /threads/{thread_id}/messages/{message_id}/files/{file_id} Retrieves a message file. |
| AssistantsApi | get_run GET /threads/{thread_id}/runs/{run_id} Retrieves a run. |
| AssistantsApi | get_run_step GET /threads/{thread_id}/runs/{run_id}/steps/{step_id} Retrieves a run step. |
| AssistantsApi | get_thread GET /threads/{thread_id} Retrieves a thread. |
| AssistantsApi | list_assistant_files GET /assistants/{assistant_id}/files Returns a list of assistant files. |
| AssistantsApi | list_assistants GET /assistants Returns a list of assistants. |
| AssistantsApi | list_message_files GET /threads/{thread_id}/messages/{message_id}/files Returns a list of message files. |
| AssistantsApi | list_messages GET /threads/{thread_id}/messages Returns a list of messages for a given thread. |
| AssistantsApi | list_run_steps GET /threads/{thread_id}/runs/{run_id}/steps Returns a list of run steps belonging to a run. |
| AssistantsApi | list_runs GET /threads/{thread_id}/runs Returns a list of runs belonging to a thread. |
| AssistantsApi | modify_assistant POST /assistants/{assistant_id} Modifies an assistant. |
| AssistantsApi | modify_message POST /threads/{thread_id}/messages/{message_id} Modifies a message. |
| AssistantsApi | modify_run POST /threads/{thread_id}/runs/{run_id} Modifies a run. |
| AssistantsApi | modify_thread POST /threads/{thread_id} Modifies a thread. |
| AssistantsApi | submit_tool_ouputs_to_run POST /threads/{thread_id}/runs/{run_id}/submit_tool_outputs When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. |
| AudioApi | create_speech POST /audio/speech Generates audio from the input text. |
| AudioApi | create_transcription POST /audio/transcriptions Transcribes audio into the input language. |
| AudioApi | create_translation POST /audio/translations Translates audio into English. |
| ChatApi | create_chat_completion POST /chat/completions Creates a model response for the given chat conversation. |
| CompletionsApi | create_completion POST /completions Creates a completion for the provided prompt and parameters. |
| EditsApi | create_edit POST /edits Creates a new edit for the provided input, instruction, and parameters. |
| EmbeddingsApi | create_embedding POST /embeddings Creates an embedding vector representing the input text. |
| FilesApi | create_file POST /files Upload a file that can be used across various endpoints. The size of all the files uploaded by one organization can be up to 100 GB. The size of individual files can be a maximum of 512 MB. See the Assistants Tools guide to learn more about the types of files supported. The Fine-tuning API only supports `.jsonl` files. Please contact us if you need to increase these storage limits. |
| FilesApi | delete_file DELETE /files/{file_id} Delete a file. |
| FilesApi | download_file GET /files/{file_id}/content Returns the contents of the specified file. |
| FilesApi | list_files GET /files Returns a list of files that belong to the user's organization. |
| FilesApi | retrieve_file GET /files/{file_id} Returns information about a specific file. |
| FineTunesApi | cancel_fine_tune POST /fine-tunes/{fine_tune_id}/cancel Immediately cancel a fine-tune job. |
| FineTunesApi | create_fine_tune POST /fine-tunes Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. Learn more about fine-tuning |
| FineTunesApi | list_fine_tune_events GET /fine-tunes/{fine_tune_id}/events Get fine-grained status updates for a fine-tune job. |
| FineTunesApi | list_fine_tunes GET /fine-tunes List your organization's fine-tuning jobs |
| FineTunesApi | retrieve_fine_tune GET /fine-tunes/{fine_tune_id} Gets info about the fine-tune job. Learn more about fine-tuning |
| FineTuningApi | cancel_fine_tuning_job POST /fine_tuning/jobs/{fine_tuning_job_id}/cancel Immediately cancel a fine-tune job. |
| FineTuningApi | create_fine_tuning_job POST /fine_tuning/jobs Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. Learn more about fine-tuning |
| FineTuningApi | list_fine_tuning_events GET /fine_tuning/jobs/{fine_tuning_job_id}/events Get status updates for a fine-tuning job. |
| FineTuningApi | list_paginated_fine_tuning_jobs GET /fine_tuning/jobs List your organization's fine-tuning jobs |
| FineTuningApi | retrieve_fine_tuning_job GET /fine_tuning/jobs/{fine_tuning_job_id} Get info about a fine-tuning job. Learn more about fine-tuning |
| ImagesApi | create_image POST /images/generations Creates an image given a prompt. |
| ImagesApi | create_image_edit POST /images/edits Creates an edited or extended image given an original image and a prompt. |
| ImagesApi | create_image_variation POST /images/variations Creates a variation of a given image. |
| ModelsApi | delete_model DELETE /models/{model} Delete a fine-tuned model. You must have the Owner role in your organization to delete a model. |
| ModelsApi | list_models GET /models Lists the currently available models, and provides basic information about each one such as the owner and availability. |
| ModelsApi | retrieve_model GET /models/{model} Retrieves a model instance, providing basic information about the model such as the owner and permissioning. |
| ModerationsApi | create_moderation POST /moderations Classifies if text violates OpenAI's Content Policy |
- AssistantFileObject
- AssistantObject
- AssistantObjectToolsInner
- AssistantToolsCode
- AssistantToolsFunction
- AssistantToolsRetrieval
- ChatCompletionFunctionCallOption
- ChatCompletionFunctions
- ChatCompletionMessageToolCall
- ChatCompletionMessageToolCallChunk
- ChatCompletionMessageToolCallChunkFunction
- ChatCompletionMessageToolCallFunction
- ChatCompletionNamedToolChoice
- ChatCompletionNamedToolChoiceFunction
- ChatCompletionRequestAssistantMessage
- ChatCompletionRequestAssistantMessageFunctionCall
- ChatCompletionRequestFunctionMessage
- ChatCompletionRequestMessage
- ChatCompletionRequestMessageContentPart
- ChatCompletionRequestMessageContentPartImage
- ChatCompletionRequestMessageContentPartImageImageUrl
- ChatCompletionRequestMessageContentPartText
- ChatCompletionRequestSystemMessage
- ChatCompletionRequestToolMessage
- ChatCompletionRequestUserMessage
- ChatCompletionRequestUserMessageContent
- ChatCompletionResponseMessage
- ChatCompletionRole
- ChatCompletionStreamResponseDelta
- ChatCompletionStreamResponseDeltaFunctionCall
- ChatCompletionTool
- ChatCompletionToolChoiceOption
- CompletionUsage
- CreateAssistantFileRequest
- CreateAssistantRequest
- CreateChatCompletionFunctionResponse
- CreateChatCompletionFunctionResponseChoicesInner
- CreateChatCompletionRequest
- CreateChatCompletionRequestFunctionCall
- CreateChatCompletionRequestModel
- CreateChatCompletionRequestResponseFormat
- CreateChatCompletionRequestStop
- CreateChatCompletionResponse
- CreateChatCompletionResponseChoicesInner
- CreateChatCompletionStreamResponse
- CreateChatCompletionStreamResponseChoicesInner
- CreateCompletionRequest
- CreateCompletionRequestModel
- CreateCompletionRequestPrompt
- CreateCompletionRequestStop
- CreateCompletionResponse
- CreateCompletionResponseChoicesInner
- CreateCompletionResponseChoicesInnerLogprobs
- CreateEditRequest
- CreateEditRequestModel
- CreateEditResponse
- CreateEditResponseChoicesInner
- CreateEmbeddingRequest
- CreateEmbeddingRequestInput
- CreateEmbeddingRequestModel
- CreateEmbeddingResponse
- CreateEmbeddingResponseUsage
- CreateFineTuneRequest
- CreateFineTuneRequestHyperparameters
- CreateFineTuneRequestHyperparametersNEpochs
- CreateFineTuneRequestModel
- CreateFineTuningJobRequest
- CreateFineTuningJobRequestHyperparameters
- CreateFineTuningJobRequestHyperparametersBatchSize
- CreateFineTuningJobRequestHyperparametersLearningRateMultiplier
- CreateFineTuningJobRequestHyperparametersNEpochs
- CreateFineTuningJobRequestModel
- CreateImageEditRequestModel
- CreateImageRequest
- CreateImageRequestModel
- CreateMessageRequest
- CreateModerationRequest
- CreateModerationRequestInput
- CreateModerationRequestModel
- CreateModerationResponse
- CreateModerationResponseResultsInner
- CreateModerationResponseResultsInnerCategories
- CreateModerationResponseResultsInnerCategoryScores
- CreateRunRequest
- CreateSpeechRequest
- CreateSpeechRequestModel
- CreateThreadAndRunRequest
- CreateThreadAndRunRequestToolsInner
- CreateThreadRequest
- CreateTranscriptionRequestModel
- CreateTranscriptionResponse
- CreateTranslationResponse
- DeleteAssistantFileResponse
- DeleteAssistantResponse
- DeleteFileResponse
- DeleteMessageResponse
- DeleteModelResponse
- DeleteThreadResponse
- Embedding
- Error
- ErrorResponse
- FineTune
- FineTuneEvent
- FineTuneHyperparams
- FineTuningJob
- FineTuningJobError
- FineTuningJobEvent
- FineTuningJobHyperparameters
- FineTuningJobHyperparametersNEpochs
- FunctionObject
- Image
- ImagesResponse
- ListAssistantFilesResponse
- ListAssistantsResponse
- ListFilesResponse
- ListFineTuneEventsResponse
- ListFineTunesResponse
- ListFineTuningJobEventsResponse
- ListMessageFilesResponse
- ListMessagesResponse
- ListModelsResponse
- ListPaginatedFineTuningJobsResponse
- ListRunStepsResponse
- ListRunsResponse
- ListThreadsResponse
- MessageContentImageFileObject
- MessageContentImageFileObjectImageFile
- MessageContentTextAnnotationsFileCitationObject
- MessageContentTextAnnotationsFileCitationObjectFileCitation
- MessageContentTextAnnotationsFilePathObject
- MessageContentTextAnnotationsFilePathObjectFilePath
- MessageContentTextObject
- MessageContentTextObjectText
- MessageContentTextObjectTextAnnotationsInner
- MessageFileObject
- MessageObject
- MessageObjectContentInner
- Model
- ModifyAssistantRequest
- ModifyMessageRequest
- ModifyRunRequest
- ModifyThreadRequest
- OpenAIFile
- RunObject
- RunObjectLastError
- RunObjectRequiredAction
- RunObjectRequiredActionSubmitToolOutputs
- RunStepDetailsMessageCreationObject
- RunStepDetailsMessageCreationObjectMessageCreation
- RunStepDetailsToolCallsCodeObject
- RunStepDetailsToolCallsCodeObjectCodeInterpreter
- RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner
- RunStepDetailsToolCallsCodeOutputImageObject
- RunStepDetailsToolCallsCodeOutputImageObjectImage
- RunStepDetailsToolCallsCodeOutputLogsObject
- RunStepDetailsToolCallsFunctionObject
- RunStepDetailsToolCallsFunctionObjectFunction
- RunStepDetailsToolCallsObject
- RunStepDetailsToolCallsObjectToolCallsInner
- RunStepDetailsToolCallsRetrievalObject
- RunStepObject
- RunStepObjectLastError
- RunStepObjectStepDetails
- RunToolCallObject
- RunToolCallObjectFunction
- SubmitToolOutputsRunRequest
- SubmitToolOutputsRunRequestToolOutputsInner
- ThreadObject
Authentication schemes defined for the API:
- Type: HTTP Bearer Token authentication