Developer Portal
  • Getting Started
  • APIs
Sign upLog in
Search
K
Log inSign up
OpenAI API
2.3.0
  • Overview
    • List organization API keysget
    • Create an organization admin API keypost
    • Retrieve a single organization API keyget
    • Delete an organization admin API keydelete
      • Returns a list of assistants.get
      • Create an assistant with a model and instructions.post
      • Retrieves an assistant.get
      • Modifies an assistant.post
      • Delete an assistant.delete
      • Create a thread.post
      • Create a thread and run it in one request.post
      • Retrieves a thread.get
      • Modifies a thread.post
      • Delete a thread.delete
      • Returns a list of messages for a given thread.get
      • Create a message.post
      • Retrieve a message.get
      • Modifies a message.post
      • Deletes a message.delete
      • Returns a list of runs belonging to a thread.get
      • Create a run.post
      • Retrieves a run.get
      • Modifies a run.post
      • Cancels a run that is `in_progress`.post
      • Returns a list of run steps belonging to a run.get
      • Retrieves a run step.get
      • 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. post
      • Generates audio from the input text.post
      • Transcribes audio into the input language.post
      • Translates audio into English.post
      • Creates a model response for the given chat conversation. Learn more in the [text generation](/docs/guides/text-generation), [vision](/docs/guides/vision), and [audio](/docs/guides/audio) guides. Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, [refer to the reasoning guide](/docs/guides/reasoning). post
      • Creates a completion for the provided prompt and parameters.post
      • Creates an embedding vector representing the input text.post
      • Creates a fine-tuning job which begins the process of creating a new 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](/docs/guides/fine-tuning) post
      • List your organization's fine-tuning jobs get
      • Get info about a fine-tuning job. [Learn more about fine-tuning](/docs/guides/fine-tuning) get
      • Immediately cancel a fine-tune job. post
      • List checkpoints for a fine-tuning job. get
      • Get status updates for a fine-tuning job. get
      • Creates and executes a batch from an uploaded file of requestspost
      • List your organization's batches.get
      • Retrieves a batch.get
      • Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file.post
      • Returns a list of files.get
      • Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and the size of all files uploaded by one organization can be up to 100 GB. The Assistants API supports files up to 2 million tokens and of specific file types. See the [Assistants Tools guide](/docs/assistants/tools) for details. The Fine-tuning API only supports `.jsonl` files. The input also has certain required formats for fine-tuning [chat](/docs/api-reference/fine-tuning/chat-input) or [completions](/docs/api-reference/fine-tuning/completions-input) models. The Batch API only supports `.jsonl` files up to 200 MB in size. The input also has a specific required [format](/docs/api-reference/batch/request-input). Please [contact us](https://help.openai.com/) if you need to increase these storage limits. post
      • Delete a file.delete
      • Returns information about a specific file.get
      • Returns the contents of the specified file.get
      • Creates an intermediate [Upload](/docs/api-reference/uploads/object) object that you can add [Parts](/docs/api-reference/uploads/part-object) to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it. Once you complete the Upload, we will create a [File](/docs/api-reference/files/object) object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object. For certain `purpose`s, the correct `mime_type` must be specified. Please refer to documentation for the supported MIME types for your use case: - [Assistants](/docs/assistants/tools/file-search#supported-files) For guidance on the proper filename extensions for each purpose, please follow the documentation on [creating a File](/docs/api-reference/files/create). post
      • Cancels the Upload. No Parts may be added after an Upload is cancelled. post
      • Completes the [Upload](/docs/api-reference/uploads/object). Within the returned Upload object, there is a nested [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform. You can specify the order of the Parts by passing in an ordered list of the Part IDs. The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed. post
      • Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload. Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB. It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](/docs/api-reference/uploads/complete). post
      • Creates an edited or extended image given an original image and a prompt.post
      • Creates an image given a prompt.post
      • Creates a variation of a given image.post
      • Lists the currently available models, and provides basic information about each one such as the owner and availability.get
      • Retrieves a model instance, providing basic information about the model such as the owner and permissioning.get
      • Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.delete
      • Classifies if text and/or image inputs are potentially harmful. Learn more in the [moderation guide](/docs/guides/moderation). post
      • List user actions and configuration changes within this organization.get
      • Get costs details for the organization.get
      • Get audio speeches usage details for the organization.get
      • Get audio transcriptions usage details for the organization.get
      • Get code interpreter sessions usage details for the organization.get
      • Get completions usage details for the organization.get
      • Get embeddings usage details for the organization.get
      • Get images usage details for the organization.get
      • Get moderations usage details for the organization.get
      • Get vector stores usage details for the organization.get
      • Returns a list of invites in the organization.get
      • Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.post
      • Retrieves an invite.get
      • Delete an invite. If the invite has already been accepted, it cannot be deleted.delete
      • Returns a list of projects.get
      • Create a new project in the organization. Projects can be created and archived, but cannot be deleted.post
      • Retrieves a project.get
      • Modifies a project in the organization.post
      • Returns a list of API keys in the project.get
      • Retrieves an API key in the project.get
      • Deletes an API key from the project.delete
      • Archives a project in the organization. Archived projects cannot be used or updated.post
      • Returns the rate limits per model for a project.get
      • Updates a project rate limit.post
      • Returns a list of service accounts in the project.get
      • Creates a new service account in the project. This also returns an unredacted API key for the service account.post
      • Retrieves a service account in the project.get
      • Deletes a service account from the project.delete
      • Returns a list of users in the project.get
      • Adds a user to the project. Users must already be members of the organization to be added to a project.post
      • Retrieves a user in the project.get
      • Modifies a user's role in the project.post
      • Deletes a user from the project.delete
      • Lists all of the users in the organization.get
      • Retrieves a user by their identifier.get
      • Modifies a user's role in the organization.post
      • Deletes a user from the organization.delete
      • Create an ephemeral API token for use in client-side applications with the Realtime API. Can be configured with the same session parameters as the `session.update` client event. It responds with a session object, plus a `client_secret` key which contains a usable ephemeral API token that can be used to authenticate browser clients for the Realtime API. post
      • Returns a list of vector stores.get
      • Create a vector store.post
      • Retrieves a vector store.get
      • Modifies a vector store.post
      • Delete a vector store.delete
      • Create a vector store file batch.post
      • Retrieves a vector store file batch.get
      • Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.post
      • Returns a list of vector store files in a batch.get
      • Returns a list of vector store files.get
      • Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).post
      • Retrieves a vector store file.get
      • Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.delete
    • AddUploadPartRequest
    • AdminApiKey
    • ApiKeyList
    • Assistant
    • AssistantStreamEvent
    • AssistantSupportedModels
    • Code interpreter tool
    • FileSearch tool
    • FileSearch tool
    • Function tool
    • AssistantsApiResponseFormatOption
    • AssistantsApiToolChoiceOption
    • AssistantsNamedToolChoice
    • AudioResponseFormat
    • AuditLog
    • AuditLogActor
    • AuditLogActorApiKey
    • AuditLogActorServiceAccount
    • AuditLogActorSession
    • AuditLogActorUser
    • AuditLogEventType
    • Auto Chunking Strategy
    • Batch
    • BatchRequestInput
    • BatchRequestOutput
    • CancelUploadRequest
    • ChatCompletionFunctionCallOption
    • ChatCompletionFunctions
    • ChatCompletionMessageToolCall
    • ChatCompletionMessageToolCallChunk
    • ChatCompletionMessageToolCalls
    • ChatCompletionModalities
    • ChatCompletionNamedToolChoice
    • Assistant message
    • ChatCompletionRequestAssistantMessageContentPart
    • Developer message
    • Function message
    • ChatCompletionRequestMessage
    • Audio content part
    • Image content part
    • Refusal content part
    • Text content part
    • System message
    • ChatCompletionRequestSystemMessageContentPart
    • Tool message
    • ChatCompletionRequestToolMessageContentPart
    • User message
    • ChatCompletionRequestUserMessageContentPart
    • ChatCompletionResponseMessage
    • ChatCompletionRole
    • ChatCompletionStreamOptions
    • ChatCompletionStreamResponseDelta
    • ChatCompletionTokenLogprob
    • ChatCompletionTool
    • ChatCompletionToolChoiceOption
    • ChunkingStrategyRequestParam
    • CompleteUploadRequest
    • CompletionUsage
    • CostsResult
    • CreateAssistantRequest
    • CreateChatCompletionFunctionResponse
    • CreateChatCompletionImageResponse
    • CreateChatCompletionRequest
    • CreateChatCompletionResponse
    • CreateChatCompletionStreamResponse
    • CreateCompletionRequest
    • CreateCompletionResponse
    • CreateEmbeddingRequest
    • CreateEmbeddingResponse
    • CreateFileRequest
    • CreateFineTuningJobRequest
    • CreateImageEditRequest
    • CreateImageRequest
    • CreateImageVariationRequest
    • CreateMessageRequest
    • CreateModerationRequest
    • CreateModerationResponse
    • CreateRunRequest
    • CreateSpeechRequest
    • CreateThreadAndRunRequest
    • CreateThreadRequest
    • CreateTranscriptionRequest
    • CreateTranscriptionResponseJson
    • CreateTranscriptionResponseVerboseJson
    • CreateTranslationRequest
    • CreateTranslationResponseJson
    • CreateTranslationResponseVerboseJson
    • CreateUploadRequest
    • CreateVectorStoreFileBatchRequest
    • CreateVectorStoreFileRequest
    • CreateVectorStoreRequest
    • DefaultProjectErrorResponse
    • DeleteAssistantResponse
    • DeleteFileResponse
    • DeleteMessageResponse
    • DeleteModelResponse
    • DeleteThreadResponse
    • DeleteVectorStoreFileResponse
    • DeleteVectorStoreResponse
    • DoneEvent
    • Embedding
    • Error
    • ErrorEvent
    • ErrorResponse
    • File search tool call ranking options
    • FineTuneChatCompletionRequestAssistantMessage
    • FineTuneChatRequestInput
    • FineTuneCompletionRequestInput
    • FineTuneDPOMethod
    • FineTuneMethod
    • FineTunePreferenceRequestInput
    • FineTuneSupervisedMethod
    • Fine-Tuning Job Integration
    • FineTuningJob
    • FineTuningJobCheckpoint
    • FineTuningJobEvent
    • FunctionObject
    • FunctionParameters
    • Image
    • ImagesResponse
    • Invite
    • InviteDeleteResponse
    • InviteListResponse
    • InviteRequest
    • ListAssistantsResponse
    • ListAuditLogsResponse
    • ListBatchesResponse
    • ListFilesResponse
    • ListFineTuningJobCheckpointsResponse
    • ListFineTuningJobEventsResponse
    • ListMessagesResponse
    • ListModelsResponse
    • ListPaginatedFineTuningJobsResponse
    • ListRunStepsResponse
    • ListRunsResponse
    • ListThreadsResponse
    • ListVectorStoreFilesResponse
    • ListVectorStoresResponse
    • Image file
    • Image URL
    • Refusal
    • File citation
    • File path
    • Text
    • Image file
    • Image URL
    • Refusal
    • File citation
    • File path
    • Text
    • Message delta object
    • The message object
    • Text
    • MessageStreamEvent
    • Metadata
    • Model
    • ModifyAssistantRequest
    • ModifyMessageRequest
    • ModifyRunRequest
    • ModifyThreadRequest
    • OpenAIFile
    • Other Chunking Strategy
    • ParallelToolCalls
    • Static Content
    • Project
    • ProjectApiKey
    • ProjectApiKeyDeleteResponse
    • ProjectApiKeyListResponse
    • ProjectCreateRequest
    • ProjectListResponse
    • ProjectRateLimit
    • ProjectRateLimitListResponse
    • ProjectRateLimitUpdateRequest
    • ProjectServiceAccount
    • ProjectServiceAccountApiKey
    • ProjectServiceAccountCreateRequest
    • ProjectServiceAccountCreateResponse
    • ProjectServiceAccountDeleteResponse
    • ProjectServiceAccountListResponse
    • ProjectUpdateRequest
    • ProjectUser
    • ProjectUserCreateRequest
    • ProjectUserDeleteResponse
    • ProjectUserListResponse
    • ProjectUserUpdateRequest
    • RealtimeClientEventConversationItemCreate
    • RealtimeClientEventConversationItemDelete
    • RealtimeClientEventConversationItemTruncate
    • RealtimeClientEventInputAudioBufferAppend
    • RealtimeClientEventInputAudioBufferClear
    • RealtimeClientEventInputAudioBufferCommit
    • RealtimeClientEventResponseCancel
    • RealtimeClientEventResponseCreate
    • RealtimeClientEventSessionUpdate
    • RealtimeConversationItem
    • RealtimeConversationItemWithReference
    • RealtimeResponse
    • RealtimeResponseCreateParams
    • RealtimeServerEventConversationCreated
    • RealtimeServerEventConversationItemCreated
    • RealtimeServerEventConversationItemDeleted
    • RealtimeServerEventConversationItemInputAudioTranscriptionCompleted
    • RealtimeServerEventConversationItemInputAudioTranscriptionFailed
    • RealtimeServerEventConversationItemTruncated
    • RealtimeServerEventError
    • RealtimeServerEventInputAudioBufferCleared
    • RealtimeServerEventInputAudioBufferCommitted
    • RealtimeServerEventInputAudioBufferSpeechStarted
    • RealtimeServerEventInputAudioBufferSpeechStopped
    • RealtimeServerEventRateLimitsUpdated
    • RealtimeServerEventResponseAudioDelta
    • RealtimeServerEventResponseAudioDone
    • RealtimeServerEventResponseAudioTranscriptDelta
    • RealtimeServerEventResponseAudioTranscriptDone
    • RealtimeServerEventResponseContentPartAdded
    • RealtimeServerEventResponseContentPartDone
    • RealtimeServerEventResponseCreated
    • RealtimeServerEventResponseDone
    • RealtimeServerEventResponseFunctionCallArgumentsDelta
    • RealtimeServerEventResponseFunctionCallArgumentsDone
    • RealtimeServerEventResponseOutputItemAdded
    • RealtimeServerEventResponseOutputItemDone
    • RealtimeServerEventResponseTextDelta
    • RealtimeServerEventResponseTextDone
    • RealtimeServerEventSessionCreated
    • RealtimeServerEventSessionUpdated
    • RealtimeSession
    • RealtimeSessionCreateRequest
    • RealtimeSessionCreateResponse
    • ReasoningEffort
    • ResponseFormatJsonObject
    • ResponseFormatJsonSchema
    • ResponseFormatJsonSchemaSchema
    • ResponseFormatText
    • RunCompletionUsage
    • A run on a thread
    • RunStepCompletionUsage
    • Run step delta object
    • Message creation
    • Code interpreter tool call
    • Code interpreter image output
    • Code interpreter log output
    • File search tool call
    • Function tool call
    • Tool calls
    • Message creation
    • Code Interpreter tool call
    • Code Interpreter image output
    • Code Interpreter log output
    • File search tool call
    • File search tool call ranking options
    • File search tool call result
    • Function tool call
    • Tool calls
    • Run steps
    • RunStepStreamEvent
    • RunStreamEvent
    • RunToolCallObject
    • StaticChunkingStrategy
    • Static Chunking Strategy
    • Static Chunking Strategy
    • SubmitToolOutputsRunRequest
    • Thread
    • ThreadStreamEvent
    • TranscriptionSegment
    • TranscriptionWord
    • Thread Truncation Controls
    • UpdateVectorStoreRequest
    • Upload
    • UploadPart
    • UsageAudioSpeechesResult
    • UsageAudioTranscriptionsResult
    • UsageCodeInterpreterSessionsResult
    • UsageCompletionsResult
    • UsageEmbeddingsResult
    • UsageImagesResult
    • UsageModerationsResult
    • UsageResponse
    • UsageTimeBucket
    • UsageVectorStoresResult
    • User
    • UserDeleteResponse
    • UserListResponse
    • UserRoleUpdateRequest
    • Vector store expiration policy
    • Vector store file batch
    • Vector store files
    • Vector store
OpenAI API
Developer Portal
Products
  • Pricing
  • APIs
  • Documentation
Company
  • About
  • Careers
  • Press
  • Events
  • Investors
Legal
  • Terms and conditions
  • Data privacy
  • Trust and compliance