# x-oaiMeta

## navigationGroups

### id

responses

### title

Responses API

### id

webhooks

### title

Webhooks

### id

endpoints

### title

Platform APIs

### id

vector_stores

### title

Vector stores

### id

containers

### title

Containers

### id

realtime

### title

Realtime

### beta

true

### id

chat

### title

Chat Completions

### id

assistants

### title

Assistants

### beta

true

### id

administration

### title

Administration

### id

legacy

### title

Legacy


## groups

### id

responses

### title

Responses

### description

OpenAI's most advanced interface for generating model responses. Supports
text and image inputs, and text outputs. Create stateful interactions
with the model, using the output of previous responses as input. Extend
the model's capabilities with built-in tools for file search, web search,
computer use, and more. Allow the model access to external systems and data
using function calling.

Related guides:
- [Quickstart](https://platform.openai.com/docs/quickstart?api-mode=responses)
- [Text inputs and outputs](https://platform.openai.com/docs/guides/text?api-mode=responses)
- [Image inputs](https://platform.openai.com/docs/guides/images?api-mode=responses)
- [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs?api-mode=responses)
- [Function calling](https://platform.openai.com/docs/guides/function-calling?api-mode=responses)
- [Conversation state](https://platform.openai.com/docs/guides/conversation-state?api-mode=responses)
- [Extend the models with tools](https://platform.openai.com/docs/guides/tools?api-mode=responses)


### navigationGroup

responses

### sections

#### type

endpoint

#### key

createResponse

#### path

create

#### type

endpoint

#### key

getResponse

#### path

get

#### type

endpoint

#### key

deleteResponse

#### path

delete

#### type

endpoint

#### key

cancelResponse

#### path

cancel

#### type

endpoint

#### key

listInputItems

#### path

input-items

#### type

object

#### key

Response

#### path

object

#### type

object

#### key

ResponseItemList

#### path

list


### id

conversations

### title

Conversations

### description

Create and manage conversations to store and retrieve conversation state across Response API calls.


### navigationGroup

responses

### sections

#### type

endpoint

#### key

createConversation

#### path

create

#### type

endpoint

#### key

getConversation

#### path

retrieve

#### type

endpoint

#### key

updateConversation

#### path

update

#### type

endpoint

#### key

deleteConversation

#### path

delete

#### type

endpoint

#### key

listConversationItems

#### path

list-items

#### type

endpoint

#### key

createConversationItems

#### path

create-items

#### type

endpoint

#### key

getConversationItem

#### path

get-item

#### type

endpoint

#### key

deleteConversationItem

#### path

delete-item

#### type

object

#### key

Conversation

#### path

object

#### type

object

#### key

ConversationItemList

#### path

list-items-object


### id

responses-streaming

### title

Streaming events

### description

When you [create a Response](https://platform.openai.com/docs/api-reference/responses/create) with
`stream` set to `true`, the server will emit server-sent events to the
client as the Response is generated. This section contains the events that
are emitted by the server.

[Learn more about streaming responses](https://platform.openai.com/docs/guides/streaming-responses?api-mode=responses).


### navigationGroup

responses

### sections

#### type

object

#### key

ResponseCreatedEvent

#### path

<auto>

#### type

object

#### key

ResponseInProgressEvent

#### path

<auto>

#### type

object

#### key

ResponseCompletedEvent

#### path

<auto>

#### type

object

#### key

ResponseFailedEvent

#### path

<auto>

#### type

object

#### key

ResponseIncompleteEvent

#### path

<auto>

#### type

object

#### key

ResponseOutputItemAddedEvent

#### path

<auto>

#### type

object

#### key

ResponseOutputItemDoneEvent

#### path

<auto>

#### type

object

#### key

ResponseContentPartAddedEvent

#### path

<auto>

#### type

object

#### key

ResponseContentPartDoneEvent

#### path

<auto>

#### type

object

#### key

ResponseTextDeltaEvent

#### path

response/output_text/delta

#### type

object

#### key

ResponseTextDoneEvent

#### path

response/output_text/done

#### type

object

#### key

ResponseRefusalDeltaEvent

#### path

<auto>

#### type

object

#### key

ResponseRefusalDoneEvent

#### path

<auto>

#### type

object

#### key

ResponseFunctionCallArgumentsDeltaEvent

#### path

<auto>

#### type

object

#### key

ResponseFunctionCallArgumentsDoneEvent

#### path

<auto>

#### type

object

#### key

ResponseFileSearchCallInProgressEvent

#### path

<auto>

#### type

object

#### key

ResponseFileSearchCallSearchingEvent

#### path

<auto>

#### type

object

#### key

ResponseFileSearchCallCompletedEvent

#### path

<auto>

#### type

object

#### key

ResponseWebSearchCallInProgressEvent

#### path

<auto>

#### type

object

#### key

ResponseWebSearchCallSearchingEvent

#### path

<auto>

#### type

object

#### key

ResponseWebSearchCallCompletedEvent

#### path

<auto>

#### type

object

#### key

ResponseReasoningSummaryPartAddedEvent

#### path

<auto>

#### type

object

#### key

ResponseReasoningSummaryPartDoneEvent

#### path

<auto>

#### type

object

#### key

ResponseReasoningSummaryTextDeltaEvent

#### path

<auto>

#### type

object

#### key

ResponseReasoningSummaryTextDoneEvent

#### path

<auto>

#### type

object

#### key

ResponseReasoningTextDeltaEvent

#### path

<auto>

#### type

object

#### key

ResponseReasoningTextDoneEvent

#### path

<auto>

#### type

object

#### key

ResponseImageGenCallCompletedEvent

#### path

<auto>

#### type

object

#### key

ResponseImageGenCallGeneratingEvent

#### path

<auto>

#### type

object

#### key

ResponseImageGenCallInProgressEvent

#### path

<auto>

#### type

object

#### key

ResponseImageGenCallPartialImageEvent

#### path

<auto>

#### type

object

#### key

ResponseMCPCallArgumentsDeltaEvent

#### path

<auto>

#### type

object

#### key

ResponseMCPCallArgumentsDoneEvent

#### path

<auto>

#### type

object

#### key

ResponseMCPCallCompletedEvent

#### path

<auto>

#### type

object

#### key

ResponseMCPCallFailedEvent

#### path

<auto>

#### type

object

#### key

ResponseMCPCallInProgressEvent

#### path

<auto>

#### type

object

#### key

ResponseMCPListToolsCompletedEvent

#### path

<auto>

#### type

object

#### key

ResponseMCPListToolsFailedEvent

#### path

<auto>

#### type

object

#### key

ResponseMCPListToolsInProgressEvent

#### path

<auto>

#### type

object

#### key

ResponseCodeInterpreterCallInProgressEvent

#### path

<auto>

#### type

object

#### key

ResponseCodeInterpreterCallInterpretingEvent

#### path

<auto>

#### type

object

#### key

ResponseCodeInterpreterCallCompletedEvent

#### path

<auto>

#### type

object

#### key

ResponseCodeInterpreterCallCodeDeltaEvent

#### path

<auto>

#### type

object

#### key

ResponseCodeInterpreterCallCodeDoneEvent

#### path

<auto>

#### type

object

#### key

ResponseOutputTextAnnotationAddedEvent

#### path

<auto>

#### type

object

#### key

ResponseQueuedEvent

#### path

<auto>

#### type

object

#### key

ResponseCustomToolCallInputDeltaEvent

#### path

<auto>

#### type

object

#### key

ResponseCustomToolCallInputDoneEvent

#### path

<auto>

#### type

object

#### key

ResponseErrorEvent

#### path

<auto>


### id

webhook-events

### title

Webhook Events

### description

Webhooks are HTTP requests sent by OpenAI to a URL you specify when certain
events happen during the course of API usage.

[Learn more about webhooks](https://platform.openai.com/docs/guides/webhooks).


### navigationGroup

webhooks

### sections

#### type

object

#### key

WebhookResponseCompleted

#### path

<auto>

#### type

object

#### key

WebhookResponseCancelled

#### path

<auto>

#### type

object

#### key

WebhookResponseFailed

#### path

<auto>

#### type

object

#### key

WebhookResponseIncomplete

#### path

<auto>

#### type

object

#### key

WebhookBatchCompleted

#### path

<auto>

#### type

object

#### key

WebhookBatchCancelled

#### path

<auto>

#### type

object

#### key

WebhookBatchExpired

#### path

<auto>

#### type

object

#### key

WebhookBatchFailed

#### path

<auto>

#### type

object

#### key

WebhookFineTuningJobSucceeded

#### path

<auto>

#### type

object

#### key

WebhookFineTuningJobFailed

#### path

<auto>

#### type

object

#### key

WebhookFineTuningJobCancelled

#### path

<auto>

#### type

object

#### key

WebhookEvalRunSucceeded

#### path

<auto>

#### type

object

#### key

WebhookEvalRunFailed

#### path

<auto>

#### type

object

#### key

WebhookEvalRunCanceled

#### path

<auto>


### id

audio

### title

Audio

### description

Learn how to turn audio into text or text into audio.

Related guide: [Speech to text](https://platform.openai.com/docs/guides/speech-to-text)


### navigationGroup

endpoints

### sections

#### type

endpoint

#### key

createSpeech

#### path

createSpeech

#### type

endpoint

#### key

createTranscription

#### path

createTranscription

#### type

endpoint

#### key

createTranslation

#### path

createTranslation

#### type

object

#### key

CreateTranscriptionResponseJson

#### path

json-object

#### type

object

#### key

CreateTranscriptionResponseVerboseJson

#### path

verbose-json-object

#### type

object

#### key

SpeechAudioDeltaEvent

#### path

speech-audio-delta-event

#### type

object

#### key

SpeechAudioDoneEvent

#### path

speech-audio-done-event

#### type

object

#### key

TranscriptTextDeltaEvent

#### path

transcript-text-delta-event

#### type

object

#### key

TranscriptTextDoneEvent

#### path

transcript-text-done-event


### id

images

### title

Images

### description

Given a prompt and/or an input image, the model will generate a new image.
Related guide: [Image generation](https://platform.openai.com/docs/guides/images)


### navigationGroup

endpoints

### sections

#### type

endpoint

#### key

createImage

#### path

create

#### type

endpoint

#### key

createImageEdit

#### path

createEdit

#### type

endpoint

#### key

createImageVariation

#### path

createVariation

#### type

object

#### key

ImagesResponse

#### path

object


### id

images-streaming

### title

Image Streaming

### description

Stream image generation and editing in real time with server-sent events.
[Learn more about image streaming](https://platform.openai.com/docs/guides/image-generation).


### navigationGroup

endpoints

### sections

#### type

object

#### key

ImageGenPartialImageEvent

#### path

<auto>

#### type

object

#### key

ImageGenCompletedEvent

#### path

<auto>

#### type

object

#### key

ImageEditPartialImageEvent

#### path

<auto>

#### type

object

#### key

ImageEditCompletedEvent

#### path

<auto>


### id

embeddings

### title

Embeddings

### description

Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
Related guide: [Embeddings](https://platform.openai.com/docs/guides/embeddings)


### navigationGroup

endpoints

### sections

#### type

endpoint

#### key

createEmbedding

#### path

create

#### type

object

#### key

Embedding

#### path

object


### id

evals

### title

Evals

### description

Create, manage, and run evals in the OpenAI platform.
Related guide: [Evals](https://platform.openai.com/docs/guides/evals)


### navigationGroup

endpoints

### sections

#### type

endpoint

#### key

createEval

#### path

create

#### type

endpoint

#### key

getEval

#### path

get

#### type

endpoint

#### key

updateEval

#### path

update

#### type

endpoint

#### key

deleteEval

#### path

delete

#### type

endpoint

#### key

listEvals

#### path

list

#### type

endpoint

#### key

getEvalRuns

#### path

getRuns

#### type

endpoint

#### key

getEvalRun

#### path

getRun

#### type

endpoint

#### key

createEvalRun

#### path

createRun

#### type

endpoint

#### key

cancelEvalRun

#### path

cancelRun

#### type

endpoint

#### key

deleteEvalRun

#### path

deleteRun

#### type

endpoint

#### key

getEvalRunOutputItem

#### path

getRunOutputItem

#### type

endpoint

#### key

getEvalRunOutputItems

#### path

getRunOutputItems

#### type

object

#### key

Eval

#### path

object

#### type

object

#### key

EvalRun

#### path

run-object

#### type

object

#### key

EvalRunOutputItem

#### path

run-output-item-object


### id

fine-tuning

### title

Fine-tuning

### description

Manage fine-tuning jobs to tailor a model to your specific training data.
Related guide: [Fine-tune models](https://platform.openai.com/docs/guides/fine-tuning)


### navigationGroup

endpoints

### sections

#### type

endpoint

#### key

createFineTuningJob

#### path

create

#### type

endpoint

#### key

listPaginatedFineTuningJobs

#### path

list

#### type

endpoint

#### key

listFineTuningEvents

#### path

list-events

#### type

endpoint

#### key

listFineTuningJobCheckpoints

#### path

list-checkpoints

#### type

endpoint

#### key

listFineTuningCheckpointPermissions

#### path

list-permissions

#### type

endpoint

#### key

createFineTuningCheckpointPermission

#### path

create-permission

#### type

endpoint

#### key

deleteFineTuningCheckpointPermission

#### path

delete-permission

#### type

endpoint

#### key

retrieveFineTuningJob

#### path

retrieve

#### type

endpoint

#### key

cancelFineTuningJob

#### path

cancel

#### type

endpoint

#### key

resumeFineTuningJob

#### path

resume

#### type

endpoint

#### key

pauseFineTuningJob

#### path

pause

#### type

object

#### key

FineTuneChatRequestInput

#### path

chat-input

#### type

object

#### key

FineTunePreferenceRequestInput

#### path

preference-input

#### type

object

#### key

FineTuneReinforcementRequestInput

#### path

reinforcement-input

#### type

object

#### key

FineTuningJob

#### path

object

#### type

object

#### key

FineTuningJobEvent

#### path

event-object

#### type

object

#### key

FineTuningJobCheckpoint

#### path

checkpoint-object

#### type

object

#### key

FineTuningCheckpointPermission

#### path

permission-object


### id

graders

### title

Graders

### description

Manage and run graders in the OpenAI platform.
Related guide: [Graders](https://platform.openai.com/docs/guides/graders)


### navigationGroup

endpoints

### sections

#### type

object

#### key

GraderStringCheck

#### path

string-check

#### type

object

#### key

GraderTextSimilarity

#### path

text-similarity

#### type

object

#### key

GraderScoreModel

#### path

score-model

#### type

object

#### key

GraderLabelModel

#### path

label-model

#### type

object

#### key

GraderPython

#### path

python

#### type

object

#### key

GraderMulti

#### path

multi

#### type

endpoint

#### key

runGrader

#### path

run

#### type

endpoint

#### key

validateGrader

#### path

validate

#### beta

true


### id

batch

### title

Batch

### description

Create large batches of API requests for asynchronous processing. The Batch API returns completions within 24 hours for a 50% discount.
Related guide: [Batch](https://platform.openai.com/docs/guides/batch)


### navigationGroup

endpoints

### sections

#### type

endpoint

#### key

createBatch

#### path

create

#### type

endpoint

#### key

retrieveBatch

#### path

retrieve

#### type

endpoint

#### key

cancelBatch

#### path

cancel

#### type

endpoint

#### key

listBatches

#### path

list

#### type

object

#### key

Batch

#### path

object

#### type

object

#### key

BatchRequestInput

#### path

request-input

#### type

object

#### key

BatchRequestOutput

#### path

request-output


### id

files

### title

Files

### description

Files are used to upload documents that can be used with features like [Assistants](https://platform.openai.com/docs/api-reference/assistants), [Fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning), and [Batch API](https://platform.openai.com/docs/guides/batch).


### navigationGroup

endpoints

### sections

#### type

endpoint

#### key

createFile

#### path

create

#### type

endpoint

#### key

listFiles

#### path

list

#### type

endpoint

#### key

retrieveFile

#### path

retrieve

#### type

endpoint

#### key

deleteFile

#### path

delete

#### type

endpoint

#### key

downloadFile

#### path

retrieve-contents

#### type

object

#### key

OpenAIFile

#### path

object


### id

uploads

### title

Uploads

### description

Allows you to upload large files in multiple parts.


### navigationGroup

endpoints

### sections

#### type

endpoint

#### key

createUpload

#### path

create

#### type

endpoint

#### key

addUploadPart

#### path

add-part

#### type

endpoint

#### key

completeUpload

#### path

complete

#### type

endpoint

#### key

cancelUpload

#### path

cancel

#### type

object

#### key

Upload

#### path

object

#### type

object

#### key

UploadPart

#### path

part-object


### id

models

### title

Models

### description

List and describe the various models available in the API. You can refer to the [Models](https://platform.openai.com/docs/models) documentation to understand what models are available and the differences between them.


### navigationGroup

endpoints

### sections

#### type

endpoint

#### key

listModels

#### path

list

#### type

endpoint

#### key

retrieveModel

#### path

retrieve

#### type

endpoint

#### key

deleteModel

#### path

delete

#### type

object

#### key

Model

#### path

object


### id

moderations

### title

Moderations

### description

Given text and/or image inputs, classifies if those inputs are potentially harmful across several categories.
Related guide: [Moderations](https://platform.openai.com/docs/guides/moderation)


### navigationGroup

endpoints

### sections

#### type

endpoint

#### key

createModeration

#### path

create

#### type

object

#### key

CreateModerationResponse

#### path

object


### id

vector-stores

### title

Vector stores

### description

Vector stores power semantic search for the Retrieval API and the `file_search` tool in the Responses and Assistants APIs.

Related guide: [File Search](https://platform.openai.com/docs/assistants/tools/file-search)


### navigationGroup

vector_stores

### sections

#### type

endpoint

#### key

createVectorStore

#### path

create

#### type

endpoint

#### key

listVectorStores

#### path

list

#### type

endpoint

#### key

getVectorStore

#### path

retrieve

#### type

endpoint

#### key

modifyVectorStore

#### path

modify

#### type

endpoint

#### key

deleteVectorStore

#### path

delete

#### type

endpoint

#### key

searchVectorStore

#### path

search

#### type

object

#### key

VectorStoreObject

#### path

object


### id

vector-stores-files

### title

Vector store files

### description

Vector store files represent files inside a vector store.

Related guide: [File Search](https://platform.openai.com/docs/assistants/tools/file-search)


### navigationGroup

vector_stores

### sections

#### type

endpoint

#### key

createVectorStoreFile

#### path

createFile

#### type

endpoint

#### key

listVectorStoreFiles

#### path

listFiles

#### type

endpoint

#### key

getVectorStoreFile

#### path

getFile

#### type

endpoint

#### key

retrieveVectorStoreFileContent

#### path

getContent

#### type

endpoint

#### key

updateVectorStoreFileAttributes

#### path

updateAttributes

#### type

endpoint

#### key

deleteVectorStoreFile

#### path

deleteFile

#### type

object

#### key

VectorStoreFileObject

#### path

file-object


### id

vector-stores-file-batches

### title

Vector store file batches

### description

Vector store file batches represent operations to add multiple files to a vector store.
Related guide: [File Search](https://platform.openai.com/docs/assistants/tools/file-search)


### navigationGroup

vector_stores

### sections

#### type

endpoint

#### key

createVectorStoreFileBatch

#### path

createBatch

#### type

endpoint

#### key

getVectorStoreFileBatch

#### path

getBatch

#### type

endpoint

#### key

cancelVectorStoreFileBatch

#### path

cancelBatch

#### type

endpoint

#### key

listFilesInVectorStoreBatch

#### path

listBatchFiles

#### type

object

#### key

VectorStoreFileBatchObject

#### path

batch-object


### id

containers

### title

Containers

### description

Create and manage containers for use with the Code Interpreter tool.


### navigationGroup

containers

### sections

#### type

endpoint

#### key

CreateContainer

#### path

createContainers

#### type

endpoint

#### key

ListContainers

#### path

listContainers

#### type

endpoint

#### key

RetrieveContainer

#### path

retrieveContainer

#### type

endpoint

#### key

DeleteContainer

#### path

deleteContainer

#### type

object

#### key

ContainerResource

#### path

object


### id

container-files

### title

Container Files

### description

Create and manage container files for use with the Code Interpreter tool.


### navigationGroup

containers

### sections

#### type

endpoint

#### key

CreateContainerFile

#### path

createContainerFile

#### type

endpoint

#### key

ListContainerFiles

#### path

listContainerFiles

#### type

endpoint

#### key

RetrieveContainerFile

#### path

retrieveContainerFile

#### type

endpoint

#### key

RetrieveContainerFileContent

#### path

retrieveContainerFileContent

#### type

endpoint

#### key

DeleteContainerFile

#### path

deleteContainerFile

#### type

object

#### key

ContainerFileResource

#### path

object


### id

realtime

### title

Realtime

### beta

true

### description

Communicate with a GPT-4o class model in real time using WebRTC or
WebSockets. Supports text and audio inputs and ouputs, along with audio
transcriptions.
[Learn more about the Realtime API](https://platform.openai.com/docs/guides/realtime).


### navigationGroup

realtime

### id

realtime-sessions

### title

Session tokens

### description

REST API endpoint to generate ephemeral session tokens for use in client-side
applications.


### navigationGroup

realtime

### sections

#### type

endpoint

#### key

create-realtime-session

#### path

create

#### type

endpoint

#### key

create-realtime-transcription-session

#### path

create-transcription

#### type

object

#### key

RealtimeSessionCreateResponse

#### path

session_object

#### type

object

#### key

RealtimeTranscriptionSessionCreateResponse

#### path

transcription_session_object


### id

realtime-client-events

### title

Client events

### description

These are events that the OpenAI Realtime WebSocket server will accept from the client.


### navigationGroup

realtime

### sections

#### type

object

#### key

RealtimeClientEventSessionUpdate

#### path

<auto>

#### type

object

#### key

RealtimeClientEventInputAudioBufferAppend

#### path

<auto>

#### type

object

#### key

RealtimeClientEventInputAudioBufferCommit

#### path

<auto>

#### type

object

#### key

RealtimeClientEventInputAudioBufferClear

#### path

<auto>

#### type

object

#### key

RealtimeClientEventConversationItemCreate

#### path

<auto>

#### type

object

#### key

RealtimeClientEventConversationItemRetrieve

#### path

<auto>

#### type

object

#### key

RealtimeClientEventConversationItemTruncate

#### path

<auto>

#### type

object

#### key

RealtimeClientEventConversationItemDelete

#### path

<auto>

#### type

object

#### key

RealtimeClientEventResponseCreate

#### path

<auto>

#### type

object

#### key

RealtimeClientEventResponseCancel

#### path

<auto>

#### type

object

#### key

RealtimeClientEventTranscriptionSessionUpdate

#### path

<auto>

#### type

object

#### key

RealtimeClientEventOutputAudioBufferClear

#### path

<auto>


### id

realtime-server-events

### title

Server events

### description

These are events emitted from the OpenAI Realtime WebSocket server to the client.


### navigationGroup

realtime

### sections

#### type

object

#### key

RealtimeServerEventError

#### path

<auto>

#### type

object

#### key

RealtimeServerEventSessionCreated

#### path

<auto>

#### type

object

#### key

RealtimeServerEventSessionUpdated

#### path

<auto>

#### type

object

#### key

RealtimeServerEventConversationCreated

#### path

<auto>

#### type

object

#### key

RealtimeServerEventConversationItemCreated

#### path

<auto>

#### type

object

#### key

RealtimeServerEventConversationItemRetrieved

#### path

<auto>

#### type

object

#### key

RealtimeServerEventConversationItemInputAudioTranscriptionCompleted

#### path

<auto>

#### type

object

#### key

RealtimeServerEventConversationItemInputAudioTranscriptionDelta

#### path

<auto>

#### type

object

#### key

RealtimeServerEventConversationItemInputAudioTranscriptionFailed

#### path

<auto>

#### type

object

#### key

RealtimeServerEventConversationItemTruncated

#### path

<auto>

#### type

object

#### key

RealtimeServerEventConversationItemDeleted

#### path

<auto>

#### type

object

#### key

RealtimeServerEventInputAudioBufferCommitted

#### path

<auto>

#### type

object

#### key

RealtimeServerEventInputAudioBufferCleared

#### path

<auto>

#### type

object

#### key

RealtimeServerEventInputAudioBufferSpeechStarted

#### path

<auto>

#### type

object

#### key

RealtimeServerEventInputAudioBufferSpeechStopped

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseCreated

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseDone

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseOutputItemAdded

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseOutputItemDone

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseContentPartAdded

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseContentPartDone

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseTextDelta

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseTextDone

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseAudioTranscriptDelta

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseAudioTranscriptDone

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseAudioDelta

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseAudioDone

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseFunctionCallArgumentsDelta

#### path

<auto>

#### type

object

#### key

RealtimeServerEventResponseFunctionCallArgumentsDone

#### path

<auto>

#### type

object

#### key

RealtimeServerEventTranscriptionSessionUpdated

#### path

<auto>

#### type

object

#### key

RealtimeServerEventRateLimitsUpdated

#### path

<auto>

#### type

object

#### key

RealtimeServerEventOutputAudioBufferStarted

#### path

<auto>

#### type

object

#### key

RealtimeServerEventOutputAudioBufferStopped

#### path

<auto>

#### type

object

#### key

RealtimeServerEventOutputAudioBufferCleared

#### path

<auto>


### id

chat

### title

Chat Completions

### description

The Chat Completions API endpoint will generate a model response from a
list of messages comprising a conversation.

Related guides:
- [Quickstart](https://platform.openai.com/docs/quickstart?api-mode=chat)
- [Text inputs and outputs](https://platform.openai.com/docs/guides/text?api-mode=chat)
- [Image inputs](https://platform.openai.com/docs/guides/images?api-mode=chat)
- [Audio inputs and outputs](https://platform.openai.com/docs/guides/audio?api-mode=chat)
- [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat)
- [Function calling](https://platform.openai.com/docs/guides/function-calling?api-mode=chat)
- [Conversation state](https://platform.openai.com/docs/guides/conversation-state?api-mode=chat)

**Starting a new project?** We recommend trying [Responses](https://platform.openai.com/docs/api-reference/responses)
to take advantage of the latest OpenAI platform features. Compare
[Chat Completions with Responses](https://platform.openai.com/docs/guides/responses-vs-chat-completions?api-mode=responses).


### navigationGroup

chat

### sections

#### type

endpoint

#### key

createChatCompletion

#### path

create

#### type

endpoint

#### key

getChatCompletion

#### path

get

#### type

endpoint

#### key

getChatCompletionMessages

#### path

getMessages

#### type

endpoint

#### key

listChatCompletions

#### path

list

#### type

endpoint

#### key

updateChatCompletion

#### path

update

#### type

endpoint

#### key

deleteChatCompletion

#### path

delete

#### type

object

#### key

CreateChatCompletionResponse

#### path

object

#### type

object

#### key

ChatCompletionList

#### path

list-object

#### type

object

#### key

ChatCompletionMessageList

#### path

message-list


### id

chat-streaming

### title

Streaming

### description

Stream Chat Completions in real time. Receive chunks of completions
returned from the model using server-sent events.
[Learn more](https://platform.openai.com/docs/guides/streaming-responses?api-mode=chat).


### navigationGroup

chat

### sections

#### type

object

#### key

CreateChatCompletionStreamResponse

#### path

streaming


### id

assistants

### title

Assistants

### beta

true

### description

Build assistants that can call models and use tools to perform tasks.

[Get started with the Assistants API](https://platform.openai.com/docs/assistants)


### navigationGroup

assistants

### sections

#### type

endpoint

#### key

createAssistant

#### path

createAssistant

#### type

endpoint

#### key

listAssistants

#### path

listAssistants

#### type

endpoint

#### key

getAssistant

#### path

getAssistant

#### type

endpoint

#### key

modifyAssistant

#### path

modifyAssistant

#### type

endpoint

#### key

deleteAssistant

#### path

deleteAssistant

#### type

object

#### key

AssistantObject

#### path

object


### id

threads

### title

Threads

### beta

true

### description

Create threads that assistants can interact with.

Related guide: [Assistants](https://platform.openai.com/docs/assistants/overview)


### navigationGroup

assistants

### sections

#### type

endpoint

#### key

createThread

#### path

createThread

#### type

endpoint

#### key

getThread

#### path

getThread

#### type

endpoint

#### key

modifyThread

#### path

modifyThread

#### type

endpoint

#### key

deleteThread

#### path

deleteThread

#### type

object

#### key

ThreadObject

#### path

object


### id

messages

### title

Messages

### beta

true

### description

Create messages within threads

Related guide: [Assistants](https://platform.openai.com/docs/assistants/overview)


### navigationGroup

assistants

### sections

#### type

endpoint

#### key

createMessage

#### path

createMessage

#### type

endpoint

#### key

listMessages

#### path

listMessages

#### type

endpoint

#### key

getMessage

#### path

getMessage

#### type

endpoint

#### key

modifyMessage

#### path

modifyMessage

#### type

endpoint

#### key

deleteMessage

#### path

deleteMessage

#### type

object

#### key

MessageObject

#### path

object


### id

runs

### title

Runs

### beta

true

### description

Represents an execution run on a thread.

Related guide: [Assistants](https://platform.openai.com/docs/assistants/overview)


### navigationGroup

assistants

### sections

#### type

endpoint

#### key

createRun

#### path

createRun

#### type

endpoint

#### key

createThreadAndRun

#### path

createThreadAndRun

#### type

endpoint

#### key

listRuns

#### path

listRuns

#### type

endpoint

#### key

getRun

#### path

getRun

#### type

endpoint

#### key

modifyRun

#### path

modifyRun

#### type

endpoint

#### key

submitToolOuputsToRun

#### path

submitToolOutputs

#### type

endpoint

#### key

cancelRun

#### path

cancelRun

#### type

object

#### key

RunObject

#### path

object


### id

run-steps

### title

Run steps

### beta

true

### description

Represents the steps (model and tool calls) taken during the run.

Related guide: [Assistants](https://platform.openai.com/docs/assistants/overview)


### navigationGroup

assistants

### sections

#### type

endpoint

#### key

listRunSteps

#### path

listRunSteps

#### type

endpoint

#### key

getRunStep

#### path

getRunStep

#### type

object

#### key

RunStepObject

#### path

step-object


### id

assistants-streaming

### title

Streaming

### beta

true

### description

Stream the result of executing a Run or resuming a Run after submitting tool outputs.
You can stream events from the [Create Thread and Run](https://platform.openai.com/docs/api-reference/runs/createThreadAndRun),
[Create Run](https://platform.openai.com/docs/api-reference/runs/createRun), and [Submit Tool Outputs](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs)
endpoints by passing `"stream": true`. The response will be a [Server-Sent events](https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events) stream.
Our Node and Python SDKs provide helpful utilities to make streaming easy. Reference the
[Assistants API quickstart](https://platform.openai.com/docs/assistants/overview) to learn more.


### navigationGroup

assistants

### sections

#### type

object

#### key

MessageDeltaObject

#### path

message-delta-object

#### type

object

#### key

RunStepDeltaObject

#### path

run-step-delta-object

#### type

object

#### key

AssistantStreamEvent

#### path

events


### id

administration

### title

Administration

### description

Programmatically manage your organization.
The Audit Logs endpoint provides a log of all actions taken in the organization for security and monitoring purposes.
To access these endpoints please generate an Admin API Key through the [API Platform Organization overview](/organization/admin-keys). Admin API keys cannot be used for non-administration endpoints.
For best practices on setting up your organization, please refer to this [guide](https://platform.openai.com/docs/guides/production-best-practices#setting-up-your-organization)


### navigationGroup

administration

### id

admin-api-keys

### title

Admin API Keys

### description

Admin API keys enable Organization Owners to programmatically manage various aspects of their organization, including users, projects, and API keys. These keys provide administrative capabilities, such as creating, updating, and deleting users; managing projects; and overseeing API key lifecycles.

Key Features of Admin API Keys:

- User Management: Invite new users, update roles, and remove users from the organization.

- Project Management: Create, update, archive projects, and manage user assignments within projects.

- API Key Oversight: List, retrieve, and delete API keys associated with projects.

Only Organization Owners have the authority to create and utilize Admin API keys. To manage these keys, Organization Owners can navigate to the Admin Keys section of their API Platform dashboard.

For direct access to the Admin Keys management page, Organization Owners can use the following link:

[https://platform.openai.com/settings/organization/admin-keys](https://platform.openai.com/settings/organization/admin-keys)

It's crucial to handle Admin API keys with care due to their elevated permissions. Adhering to best practices, such as regular key rotation and assigning appropriate permissions, enhances security and ensures proper governance within the organization.


### navigationGroup

administration

### sections

#### type

endpoint

#### key

admin-api-keys-list

#### path

list

#### type

endpoint

#### key

admin-api-keys-create

#### path

create

#### type

endpoint

#### key

admin-api-keys-get

#### path

listget

#### type

endpoint

#### key

admin-api-keys-delete

#### path

delete

#### type

object

#### key

AdminApiKey

#### path

object


### id

invite

### title

Invites

### description

Invite and manage invitations for an organization.

### navigationGroup

administration

### sections

#### type

endpoint

#### key

list-invites

#### path

list

#### type

endpoint

#### key

inviteUser

#### path

create

#### type

endpoint

#### key

retrieve-invite

#### path

retrieve

#### type

endpoint

#### key

delete-invite

#### path

delete

#### type

object

#### key

Invite

#### path

object


### id

users

### title

Users

### description

Manage users and their role in an organization.


### navigationGroup

administration

### sections

#### type

endpoint

#### key

list-users

#### path

list

#### type

endpoint

#### key

modify-user

#### path

modify

#### type

endpoint

#### key

retrieve-user

#### path

retrieve

#### type

endpoint

#### key

delete-user

#### path

delete

#### type

object

#### key

User

#### path

object


### id

projects

### title

Projects

### description

Manage the projects within an orgnanization includes creation, updating, and archiving or projects.
The Default project cannot be archived.


### navigationGroup

administration

### sections

#### type

endpoint

#### key

list-projects

#### path

list

#### type

endpoint

#### key

create-project

#### path

create

#### type

endpoint

#### key

retrieve-project

#### path

retrieve

#### type

endpoint

#### key

modify-project

#### path

modify

#### type

endpoint

#### key

archive-project

#### path

archive

#### type

object

#### key

Project

#### path

object


### id

project-users

### title

Project users

### description

Manage users within a project, including adding, updating roles, and removing users.


### navigationGroup

administration

### sections

#### type

endpoint

#### key

list-project-users

#### path

list

#### type

endpoint

#### key

create-project-user

#### path

create

#### type

endpoint

#### key

retrieve-project-user

#### path

retrieve

#### type

endpoint

#### key

modify-project-user

#### path

modify

#### type

endpoint

#### key

delete-project-user

#### path

delete

#### type

object

#### key

ProjectUser

#### path

object


### id

project-service-accounts

### title

Project service accounts

### description

Manage service accounts within a project. A service account is a bot user that is not associated with a user.
If a user leaves an organization, their keys and membership in projects will no longer work. Service accounts
do not have this limitation. However, service accounts can also be deleted from a project.


### navigationGroup

administration

### sections

#### type

endpoint

#### key

list-project-service-accounts

#### path

list

#### type

endpoint

#### key

create-project-service-account

#### path

create

#### type

endpoint

#### key

retrieve-project-service-account

#### path

retrieve

#### type

endpoint

#### key

delete-project-service-account

#### path

delete

#### type

object

#### key

ProjectServiceAccount

#### path

object


### id

project-api-keys

### title

Project API keys

### description

Manage API keys for a given project. Supports listing and deleting keys for users.
This API does not allow issuing keys for users, as users need to authorize themselves to generate keys.


### navigationGroup

administration

### sections

#### type

endpoint

#### key

list-project-api-keys

#### path

list

#### type

endpoint

#### key

retrieve-project-api-key

#### path

retrieve

#### type

endpoint

#### key

delete-project-api-key

#### path

delete

#### type

object

#### key

ProjectApiKey

#### path

object


### id

project-rate-limits

### title

Project rate limits

### description

Manage rate limits per model for projects. Rate limits may be configured to be equal to or lower than the organization's rate limits.


### navigationGroup

administration

### sections

#### type

endpoint

#### key

list-project-rate-limits

#### path

list

#### type

endpoint

#### key

update-project-rate-limits

#### path

update

#### type

object

#### key

ProjectRateLimit

#### path

object


### id

audit-logs

### title

Audit logs

### description

Logs of user actions and configuration changes within this organization.
To log events, an Organization Owner must activate logging in the [Data Controls Settings](/settings/organization/data-controls/data-retention).
Once activated, for security reasons, logging cannot be deactivated.


### navigationGroup

administration

### sections

#### type

endpoint

#### key

list-audit-logs

#### path

list

#### type

object

#### key

AuditLog

#### path

object


### id

usage

### title

Usage

### description

The **Usage API** provides detailed insights into your activity across the OpenAI API. It also includes a separate [Costs endpoint](https://platform.openai.com/docs/api-reference/usage/costs), which offers visibility into your spend, breaking down consumption by invoice line items and project IDs.

While the Usage API delivers granular usage data, it may not always reconcile perfectly with the Costs due to minor differences in how usage and spend are recorded. For financial purposes, we recommend using the [Costs endpoint](https://platform.openai.com/docs/api-reference/usage/costs) or the [Costs tab](/settings/organization/usage) in the Usage Dashboard, which will reconcile back to your billing invoice.


### navigationGroup

administration

### sections

#### type

endpoint

#### key

usage-completions

#### path

completions

#### type

object

#### key

UsageCompletionsResult

#### path

completions_object

#### type

endpoint

#### key

usage-embeddings

#### path

embeddings

#### type

object

#### key

UsageEmbeddingsResult

#### path

embeddings_object

#### type

endpoint

#### key

usage-moderations

#### path

moderations

#### type

object

#### key

UsageModerationsResult

#### path

moderations_object

#### type

endpoint

#### key

usage-images

#### path

images

#### type

object

#### key

UsageImagesResult

#### path

images_object

#### type

endpoint

#### key

usage-audio-speeches

#### path

audio_speeches

#### type

object

#### key

UsageAudioSpeechesResult

#### path

audio_speeches_object

#### type

endpoint

#### key

usage-audio-transcriptions

#### path

audio_transcriptions

#### type

object

#### key

UsageAudioTranscriptionsResult

#### path

audio_transcriptions_object

#### type

endpoint

#### key

usage-vector-stores

#### path

vector_stores

#### type

object

#### key

UsageVectorStoresResult

#### path

vector_stores_object

#### type

endpoint

#### key

usage-code-interpreter-sessions

#### path

code_interpreter_sessions

#### type

object

#### key

UsageCodeInterpreterSessionsResult

#### path

code_interpreter_sessions_object

#### type

endpoint

#### key

usage-costs

#### path

costs

#### type

object

#### key

CostsResult

#### path

costs_object


### id

certificates

### beta

true

### title

Certificates

### description

Manage Mutual TLS certificates across your organization and projects.

[Learn more about Mutual TLS.](https://help.openai.com/en/articles/10876024-openai-mutual-tls-beta-program)


### navigationGroup

administration

### sections

#### type

endpoint

#### key

uploadCertificate

#### path

uploadCertificate

#### type

endpoint

#### key

getCertificate

#### path

getCertificate

#### type

endpoint

#### key

modifyCertificate

#### path

modifyCertificate

#### type

endpoint

#### key

deleteCertificate

#### path

deleteCertificate

#### type

endpoint

#### key

listOrganizationCertificates

#### path

listOrganizationCertificates

#### type

endpoint

#### key

listProjectCertificates

#### path

listProjectCertificates

#### type

endpoint

#### key

activateOrganizationCertificates

#### path

activateOrganizationCertificates

#### type

endpoint

#### key

deactivateOrganizationCertificates

#### path

deactivateOrganizationCertificates

#### type

endpoint

#### key

activateProjectCertificates

#### path

activateProjectCertificates

#### type

endpoint

#### key

deactivateProjectCertificates

#### path

deactivateProjectCertificates

#### type

object

#### key

Certificate

#### path

object


### id

completions

### title

Completions

### legacy

true

### navigationGroup

legacy

### description

Given a prompt, the model will return one or more predicted completions along with the probabilities of alternative tokens at each position. Most developer should use our [Chat Completions API](https://platform.openai.com/docs/guides/text-generation#text-generation-models) to leverage our best and newest models.


### sections

#### type

endpoint

#### key

createCompletion

#### path

create

#### type

object

#### key

CreateCompletionResponse

#### path

object