Expand description
OpenAI API schemas
Structs§
- AddUpload
Part Request - Admin
ApiKey - Represents an individual Admin API key in an org.
- Admin
ApiKey_ Owner - ApiKey
List - Approximate
Location - Assistant
Object - Represents an
assistantthat can call the model and use tools. - Assistant
Object_ Tool Resources - A set of resources that are used by the assistant’s tools.
- Assistant
Object_ Tool Resources_ Code Interpreter - Assistant
Object_ Tool Resources_ File Search - Assistant
Tools Code - Assistant
Tools File Search - Assistant
Tools File Search Type Only - Assistant
Tools File Search_ File Search - Overrides for the file search tool.
- Assistant
Tools Function - Assistants
Named Tool Choice - Specifies a tool the model should use.
- Assistants
Named Tool Choice_ Function - Audit
Log - A log of a user action or configuration change within this organization.
- Audit
LogActor - The actor who performed the audit logged action.
- Audit
LogActor ApiKey - The API Key used to perform the audit logged action.
- Audit
LogActor Service Account - The service account that performed the audit logged action.
- Audit
LogActor Session - The session in which the audit logged action was performed.
- Audit
LogActor User - The user who performed the audit logged action.
- Audit
Log_ ApiKey Created - The details for events with this
type. - Audit
Log_ ApiKey Created_ Data - The payload used to create the API key.
- Audit
Log_ ApiKey Deleted - The details for events with this
type. - Audit
Log_ ApiKey Updated - The details for events with this
type. - Audit
Log_ ApiKey Updated_ Changes Requested - The payload used to update the API key.
- Audit
Log_ Certificate Created - The details for events with this
type. - Audit
Log_ Certificate Deleted - The details for events with this
type. - Audit
Log_ Certificate Updated - The details for events with this
type. - Audit
Log_ Certificates Activated - The details for events with this
type. - Audit
Log_ Certificates Activated_ Certificates - Audit
Log_ Certificates Deactivated - The details for events with this
type. - Audit
Log_ Certificates Deactivated_ Certificates - Audit
Log_ Checkpoint Permission Created - The project and fine-tuned model checkpoint that the checkpoint permission was created for.
- Audit
Log_ Checkpoint Permission Created_ Data - The payload used to create the checkpoint permission.
- Audit
Log_ Checkpoint Permission Deleted - The details for events with this
type. - Audit
Log_ Invite Accepted - The details for events with this
type. - Audit
Log_ Invite Deleted - The details for events with this
type. - Audit
Log_ Invite Sent - The details for events with this
type. - Audit
Log_ Invite Sent_ Data - The payload used to create the invite.
- Audit
Log_ Login Failed - The details for events with this
type. - Audit
Log_ Logout Failed - The details for events with this
type. - Audit
Log_ Organization Updated - The details for events with this
type. - Audit
Log_ Organization Updated_ Changes Requested - The payload used to update the organization settings.
- Audit
Log_ Organization Updated_ Changes Requested_ Settings - Audit
Log_ Project - The project that the action was scoped to.
- Audit
Log_ Project Archived - The details for events with this
type. - Audit
Log_ Project Created - The details for events with this
type. - Audit
Log_ Project Created_ Data - The payload used to create the project.
- Audit
Log_ Project Updated - The details for events with this
type. - Audit
Log_ Project Updated_ Changes Requested - The payload used to update the project.
- Audit
Log_ Rate Limit Deleted - The details for events with this
type. - Audit
Log_ Rate Limit Updated - The details for events with this
type. - Audit
Log_ Rate Limit Updated_ Changes Requested - The payload used to update the rate limits.
- Audit
Log_ Service Account Created - The details for events with this
type. - Audit
Log_ Service Account Created_ Data - The payload used to create the service account.
- Audit
Log_ Service Account Deleted - The details for events with this
type. - Audit
Log_ Service Account Updated - The details for events with this
type. - Audit
Log_ Service Account Updated_ Changes Requested - The payload used to updated the service account.
- Audit
Log_ User Added - The details for events with this
type. - Audit
Log_ User Added_ Data - The payload used to add the user to the project.
- Audit
Log_ User Deleted - The details for events with this
type. - Audit
Log_ User Updated - The details for events with this
type. - Audit
Log_ User Updated_ Changes Requested - The payload used to update the user.
- Auto
Chunking Strategy Request Param - The default strategy.
- Batch
- Batch
Request Input - The per-line object of the batch input file
- Batch
Request Output - The per-line object of the batch output and error files
- Batch
Request Output_ Error - For requests that failed with a non-HTTP error, this will contain more information on the cause of the failure.
- Batch
Request Output_ Response - Batch
Request Output_ Response_ Body - The JSON body of the response
- Batch_
Errors - Batch_
Errors_ Data - Batch_
Request Counts - The request counts for different statuses within the batch.
- Certificate
- Represents an individual
certificateuploaded to the organization. - Certificate_
Certificate Details - Chat
Completion Deleted - Chat
Completion Function Call Option - Specifying a particular function via
{"name": "my_function"}forces the model to call that function. - Chat
Completion Functions - Chat
Completion List - An object representing a list of Chat Completions.
- Chat
Completion Message List - An object representing a list of chat completion messages.
- Chat
Completion Message List_ Data - Chat
Completion Message List_ Data_ Variant2 - Chat
Completion Message Tool Call - Chat
Completion Message Tool Call Chunk - Chat
Completion Message Tool Call Chunk_ Function - Chat
Completion Message Tool Call_ Function - The function that the model called.
- Chat
Completion Named Tool Choice - Specifies a tool the model should use.
- Chat
Completion Named Tool Choice_ Function - Chat
Completion Request Assistant Message - Messages sent by the model in response to user messages.
- Chat
Completion Request Assistant Message_ Audio - Data about a previous audio response from the model.
- Chat
Completion Request Assistant Message_ Function Call - Deprecated and replaced by
tool_calls. - Chat
Completion Request Developer Message - Developer-provided instructions that the model should follow, regardless of messages sent by the user.
- Chat
Completion Request Function Message - Chat
Completion Request Message Content Part Audio - Learn about audio inputs.
- Chat
Completion Request Message Content Part Audio_ Input Audio - Chat
Completion Request Message Content Part File - Learn about file inputs for text generation.
- Chat
Completion Request Message Content Part File_ File - Chat
Completion Request Message Content Part Image - Learn about image inputs.
- Chat
Completion Request Message Content Part Image_ Image Url - Chat
Completion Request Message Content Part Refusal - Chat
Completion Request Message Content Part Text - Learn about text inputs.
- Chat
Completion Request System Message - Developer-provided instructions that the model should follow, regardless of messages sent by the user.
- Chat
Completion Request Tool Message - Chat
Completion Request User Message - Messages sent by an end user, containing prompts or additional context information.
- Chat
Completion Response Message - A chat completion message generated by the model.
- Chat
Completion Response Message_ Annotations - A URL citation when using web search.
- Chat
Completion Response Message_ Annotations_ UrlCitation - A URL citation when using web search.
- Chat
Completion Response Message_ Audio - If the audio output modality is requested, this object contains data about the audio response from the model.
- Chat
Completion Response Message_ Function Call - Deprecated and replaced by
tool_calls. - Chat
Completion Stream Options - Options for streaming response.
- Chat
Completion Stream Response Delta - A chat completion delta generated by streamed model responses.
- Chat
Completion Stream Response Delta_ Function Call - Deprecated and replaced by
tool_calls. - Chat
Completion Token Logprob - Chat
Completion Token Logprob_ TopLogprobs - Chat
Completion Tool - Click
- A click action.
- Code
Interpreter File Output - The output of a code interpreter tool call that is a file.
- Code
Interpreter File Output_ Files - Code
Interpreter Text Output - The output of a code interpreter tool call that is text.
- Code
Interpreter Tool Call - A tool call to run code.
- Comparison
Filter - A filter used to compare a specified attribute key to a given value using a defined comparison operation.
- Complete
Upload Request - Completion
Usage - Usage statistics for the completion request.
- Completion
Usage_ Completion Tokens Details - Breakdown of tokens used in a completion.
- Completion
Usage_ Prompt Tokens Details - Breakdown of tokens used in the prompt.
- Compound
Filter - Combine multiple filters using
andoror. - Computer
Call Output Item Param - The output of a computer tool call.
- Computer
Call Safety Check Param - A pending safety check for the computer call.
- Computer
Screenshot Image - A computer screenshot image used with the computer use tool.
- Computer
Tool Call - A tool call to a computer use tool.
- Computer
Tool Call Output - The output of a computer tool call.
- Computer
Tool Call Output Resource - Computer
Tool Call Output Resource_ Variant2 - Computer
Tool Call Safety Check - A pending safety check for the computer call.
- Computer
UsePreview Tool - A tool that controls a virtual computer.
- Coordinate
- An x/y coordinate pair, e.g.
- Costs
Result - The aggregated costs details of the specific time bucket.
- Costs
Result_ Amount - The monetary value in its associated currency.
- Create
Assistant Request - Create
Assistant Request_ Tool Resources - A set of resources that are used by the assistant’s tools.
- Create
Assistant Request_ Tool Resources_ Code Interpreter - Create
Assistant Request_ Tool Resources_ File Search - Create
Assistant Request_ Tool Resources_ File Search_ Vector Stores - Create
Chat Completion Request - Create
Chat Completion Request_ Logit Bias - Modify the likelihood of specified tokens appearing in the completion.
- Create
Chat Completion Request_ Variant2 - Create
Chat Completion Request_ Variant2_ Audio - Parameters for audio output.
- Create
Chat Completion Request_ Variant2_ Logit Bias - Modify the likelihood of specified tokens appearing in the completion.
- Create
Chat Completion Request_ Variant2_ WebSearch Options - This tool searches the web for relevant results to use in a response.
- Create
Chat Completion Request_ Variant2_ WebSearch Options_ User Location - Approximate location parameters for the search.
- Create
Chat Completion Response - Represents a chat completion response returned by model, based on the provided input.
- Create
Chat Completion Response_ Choices - Create
Chat Completion Response_ Choices_ Logprobs - Log probability information for the choice.
- Create
Chat Completion Stream Response - Represents a streamed chunk of a chat completion response returned by the model, based on the provided input.
- Create
Chat Completion Stream Response_ Choices - Create
Chat Completion Stream Response_ Choices_ Logprobs - Log probability information for the choice.
- Create
Completion Request - Create
Completion Request_ Logit Bias - Modify the likelihood of specified tokens appearing in the completion.
- Create
Completion Response - Represents a completion response from the API.
- Create
Completion Response_ Choices - Create
Completion Response_ Choices_ Logprobs - Create
Completion Response_ Choices_ Logprobs_ TopLogprobs - Create
Embedding Request - Create
Embedding Response - Create
Embedding Response_ Usage - The usage information for the request.
- Create
Eval Completions RunData Source - A CompletionsRunDataSource object describing a model sampling configuration.
- Create
Eval Completions RunData Source_ Input Messages_ Variant1 - Create
Eval Completions RunData Source_ Input Messages_ Variant2 - Create
Eval Completions RunData Source_ Sampling Params - Create
Eval Custom Data Source Config - A CustomDataSourceConfig object that defines the schema for the data source used for the evaluation runs.
- Create
Eval Custom Data Source Config_ Item Schema - The json schema for each row in the data source.
- Create
Eval Item_ Variant1 - Create
Eval Jsonl RunData Source - A JsonlRunDataSource object with that specifies a JSONL file that matches the eval
- Create
Eval Label Model Grader - A LabelModelGrader object which uses a model to assign labels to each item in the evaluation.
- Create
Eval Logs Data Source Config - A data source config which specifies the metadata property of your stored completions query.
- Create
Eval Logs Data Source Config_ Metadata - Metadata filters for the logs data source.
- Create
Eval Request - Create
Eval Responses RunData Source - A ResponsesRunDataSource object describing a model sampling configuration.
- Create
Eval Responses RunData Source_ Input Messages_ Variant1 - Create
Eval Responses RunData Source_ Input Messages_ Variant2 - Create
Eval Responses RunData Source_ Input Messages_ Variant1_ Template_ Variant1 - Create
Eval Responses RunData Source_ Sampling Params - Create
Eval RunRequest - Create
File Request - Create
Fine Tuning Checkpoint Permission Request - Create
Fine Tuning JobRequest - Create
Fine Tuning JobRequest_ Hyperparameters - The hyperparameters used for the fine-tuning job.
- Create
Fine Tuning JobRequest_ Integrations - Create
Fine Tuning JobRequest_ Integrations_ Wandb - The settings for your integration with Weights and Biases.
- Create
Image Edit Request - Create
Image Request - Create
Image Variation Request - Create
Message Request - Create
Message Request_ Attachments - Create
Moderation Request - Create
Moderation Request_ Input_ Variant3_ Variant1 - An object describing an image to classify.
- Create
Moderation Request_ Input_ Variant3_ Variant2 - An object describing text to classify.
- Create
Moderation Request_ Input_ Variant3_ Variant1_ Image Url - Contains either an image URL or a data URL for a base64 encoded image.
- Create
Moderation Response - Represents if a given text input is potentially harmful.
- Create
Moderation Response_ Results - Create
Moderation Response_ Results_ Categories - A list of the categories, and whether they are flagged or not.
- Create
Moderation Response_ Results_ Category Applied Input Types - A list of the categories along with the input type(s) that the score applies to.
- Create
Moderation Response_ Results_ Category Scores - A list of the categories along with their scores as predicted by model.
- Create
Response - Create
Response_ Variant3 - Create
RunRequest - Create
Speech Request - Create
Thread AndRun Request - Create
Thread AndRun Request_ Tool Resources - A set of resources that are used by the assistant’s tools.
- Create
Thread AndRun Request_ Tool Resources_ Code Interpreter - Create
Thread AndRun Request_ Tool Resources_ File Search - Create
Thread Request - Options to create a new thread.
- Create
Thread Request_ Tool Resources - A set of resources that are made available to the assistant’s tools in this thread.
- Create
Thread Request_ Tool Resources_ Code Interpreter - Create
Thread Request_ Tool Resources_ File Search - Create
Thread Request_ Tool Resources_ File Search_ Vector Stores - Create
Transcription Request - Create
Transcription Response Json - Represents a transcription response returned by model, based on the provided input.
- Create
Transcription Response Json_ Logprobs - Create
Transcription Response Verbose Json - Represents a verbose json transcription response returned by model, based on the provided input.
- Create
Translation Request - Create
Translation Response Json - Create
Translation Response Verbose Json - Create
Upload Request - Create
Vector Store File Batch Request - Create
Vector Store File Request - Create
Vector Store Request - Delete
Assistant Response - Delete
Certificate Response - Delete
File Response - Delete
Fine Tuning Checkpoint Permission Response - Delete
Message Response - Delete
Model Response - Delete
Thread Response - Delete
Vector Store File Response - Delete
Vector Store Response - Done
Event - Occurs when a stream ends.
- Double
Click - A double click action.
- Drag
- A drag action.
- Easy
Input Message - A message input to the model with a role indicating instruction following hierarchy.
- Embedding
- Represents an embedding vector returned by embedding endpoint.
- Error
- Error
Event - Occurs when an error occurs.
- Error
Response - Eval
- An Eval object with a data source config and testing criteria.
- Eval
ApiError - An object representing an error response from the Eval API.
- Eval
Custom Data Source Config - A CustomDataSourceConfig which specifies the schema of your
itemand optionallysamplenamespaces. - Eval
Custom Data Source Config_ Schema - The json schema for the run data source items.
- Eval
Item - A message input to the model with a role indicating instruction following hierarchy.
- Eval
Item_ Content_ Variant3 - A text output from the model.
- Eval
Jsonl File Content Source - Eval
Jsonl File Content Source_ Content - Eval
Jsonl File Content Source_ Content_ Item - Eval
Jsonl File Content Source_ Content_ Sample - Eval
Jsonl File IdSource - Eval
Label Model Grader - A LabelModelGrader object which uses a model to assign labels to each item in the evaluation.
- Eval
List - An object representing a list of evals.
- Eval
Python Grader - A PythonGrader object that runs a python script on the input.
- Eval
Responses Source - A EvalResponsesSource object describing a run data source configuration.
- Eval
Responses Source_ Metadata - Metadata filter for the responses.
- EvalRun
- A schema representing an evaluation run.
- Eval
RunList - An object representing a list of runs for an evaluation.
- Eval
RunOutput Item - A schema representing an evaluation run output item.
- Eval
RunOutput Item List - An object representing a list of output items for an evaluation run.
- Eval
RunOutput Item_ Datasource Item - Details of the input data source item.
- Eval
RunOutput Item_ Results - A result object.
- Eval
RunOutput Item_ Sample - A sample containing the input and output of the evaluation run.
- Eval
RunOutput Item_ Sample_ Input - An input message.
- Eval
RunOutput Item_ Sample_ Output - Eval
RunOutput Item_ Sample_ Usage - Token usage details for the sample.
- Eval
Run_ PerModel Usage - Eval
Run_ PerTesting Criteria Results - Eval
Run_ Result Counts - Counters summarizing the outcomes of the evaluation run.
- Eval
Score Model Grader - A ScoreModelGrader object that uses a model to assign a score to the input.
- Eval
Score Model Grader_ Sampling Params - The sampling parameters for the model.
- Eval
Stored Completions Data Source Config - A StoredCompletionsDataSourceConfig which specifies the metadata property of your stored completions query.
- Eval
Stored Completions Data Source Config_ Schema - The json schema for the run data source items.
- Eval
Stored Completions Source - A StoredCompletionsRunDataSource configuration describing a set of filters
- Eval
String Check Grader - A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.
- Eval
Text Similarity Grader - A TextSimilarityGrader object which grades text based on similarity metrics.
- File
Citation Body - A citation to a file.
- File
Path - A path to a file.
- File
Search Ranking Options - The ranking options for the file search.
- File
Search Tool - A tool that searches for relevant content from uploaded files.
- File
Search Tool Call - The results of a file search tool call.
- File
Search Tool Call_ Results - Fine
Tune Chat Completion Request Assistant Message - Fine
Tune Chat Completion Request Assistant Message_ Variant1 - Fine
Tune Chat Request Input - The per-line training example of a fine-tuning input file for chat models using the supervised method.
- Fine
Tune Completion Request Input - The per-line training example of a fine-tuning input file for completions models
- Fine
TuneDPO Method - Configuration for the DPO fine-tuning method.
- Fine
TuneDPO Method_ Hyperparameters - The hyperparameters used for the fine-tuning job.
- Fine
Tune Method - The method used for fine-tuning.
- Fine
Tune Preference Request Input - The per-line training example of a fine-tuning input file for chat models using the dpo method.
- Fine
Tune Preference Request Input_ Input - Fine
Tune Supervised Method - Configuration for the supervised fine-tuning method.
- Fine
Tune Supervised Method_ Hyperparameters - The hyperparameters used for the fine-tuning job.
- Fine
Tuning Checkpoint Permission - The
checkpoint.permissionobject represents a permission for a fine-tuned model checkpoint. - Fine
Tuning Integration - Fine
Tuning Integration_ Wandb - The settings for your integration with Weights and Biases.
- Fine
Tuning Job - The
fine_tuning.jobobject represents a fine-tuning job that has been created through the API. - Fine
Tuning JobCheckpoint - The
fine_tuning.job.checkpointobject represents a model checkpoint for a fine-tuning job that is ready to use. - Fine
Tuning JobCheckpoint_ Metrics - Metrics at the step number during the fine-tuning job.
- Fine
Tuning JobEvent - Fine-tuning job event object
- Fine
Tuning JobEvent_ Data - The data associated with the event.
- Fine
Tuning Job_ Error - For fine-tuning jobs that have
failed, this will contain more information on the cause of the failure. - Fine
Tuning Job_ Hyperparameters - The hyperparameters used for the fine-tuning job.
- Function
Call Output Item Param - The output of a function tool call.
- Function
Object - Function
Parameters - The parameters the functions accepts, described as a JSON Schema object.
- Function
Tool - Defines a function in your own code the model can choose to call.
- Function
Tool Call - A tool call to run a function.
- Function
Tool Call Output - The output of a function tool call.
- Function
Tool Call Output Resource - Function
Tool Call Output Resource_ Variant2 - Function
Tool Call Resource - Function
Tool Call Resource_ Variant2 - Function
Tool_ Parameters_ 1 - A JSON schema object describing the parameters of the function.
- Image
- Represents the content or the URL of an image generated by the OpenAI API.
- Images
Response - The response from the image generation endpoint.
- Images
Response_ Usage - For
gpt-image-1only, the token usage information for the image generation. - Images
Response_ Usage_ Input Tokens Details - The input tokens detailed information for the image generation.
- Input
Audio - An audio input to the model.
- Input
File Content - A file input to the model.
- Input
Image Content - An image input to the model.
- Input
Message - A message input to the model with a role indicating instruction following hierarchy.
- Input
Message Resource - Input
Message Resource_ Variant2 - Input
Text Content - A text input to the model.
- Invite
- Represents an individual
inviteto the organization. - Invite
Delete Response - Invite
List Response - Invite
Request - Invite
Request_ Projects - Invite_
Projects - Item
Reference Param - An internal identifier for an item to reference.
- KeyPress
- A collection of keypresses the model would like to perform.
- List
Assistants Response - List
Audit Logs Response - List
Batches Response - List
Certificates Response - List
Files Response - List
Fine Tuning Checkpoint Permission Response - List
Fine Tuning JobCheckpoints Response - List
Fine Tuning JobEvents Response - List
Messages Response - List
Models Response - List
Paginated Fine Tuning Jobs Response - List
RunSteps Response - List
Runs Response - List
Vector Store Files Response - List
Vector Stores Response - LogProb
Properties - A log probability object.
- Message
Content Image File Object - References an image File in the content of a message.
- Message
Content Image File Object_ Image File - Message
Content Image UrlObject - References an image URL in the content of a message.
- Message
Content Image UrlObject_ Image Url - Message
Content Refusal Object - The refusal content generated by the assistant.
- Message
Content Text Annotations File Citation Object - A citation within the message that points to a specific quote from a specific File associated with the assistant or the message.
- Message
Content Text Annotations File Citation Object_ File Citation - Message
Content Text Annotations File Path Object - A URL for the file that’s generated when the assistant used the
code_interpretertool to generate a file. - Message
Content Text Annotations File Path Object_ File Path - Message
Content Text Object - The text content that is part of a message.
- Message
Content Text Object_ Text - Message
Delta Content Image File Object - References an image File in the content of a message.
- Message
Delta Content Image File Object_ Image File - Message
Delta Content Image UrlObject - References an image URL in the content of a message.
- Message
Delta Content Image UrlObject_ Image Url - Message
Delta Content Refusal Object - The refusal content that is part of a message.
- Message
Delta Content Text Annotations File Citation Object - A citation within the message that points to a specific quote from a specific File associated with the assistant or the message.
- Message
Delta Content Text Annotations File Citation Object_ File Citation - Message
Delta Content Text Annotations File Path Object - A URL for the file that’s generated when the assistant used the
code_interpretertool to generate a file. - Message
Delta Content Text Annotations File Path Object_ File Path - Message
Delta Content Text Object - The text content that is part of a message.
- Message
Delta Content Text Object_ Text - Message
Delta Object - Represents a message delta i.e.
- Message
Delta Object_ Delta - The delta containing the fields that have changed on the Message.
- Message
Object - Represents a message within a thread.
- Message
Object_ Attachments - Message
Object_ Incomplete Details - On an incomplete message, details about why the message is incomplete.
- Message
Request Content Text Object - The text content that is part of a message.
- Message
Stream Event_ Variant1 - Occurs when a message is created.
- Message
Stream Event_ Variant2 - Occurs when a message moves to an
in_progressstate. - Message
Stream Event_ Variant3 - Occurs when parts of a Message are being streamed.
- Message
Stream Event_ Variant4 - Occurs when a message is completed.
- Message
Stream Event_ Variant5 - Occurs when a message ends before it is completed.
- Metadata
- Set of 16 key-value pairs that can be attached to an object.
- Model
- Describes an OpenAI model offering that can be used with the API.
- Model
Response Properties - Modify
Assistant Request - Modify
Assistant Request_ Tool Resources - A set of resources that are used by the assistant’s tools.
- Modify
Assistant Request_ Tool Resources_ Code Interpreter - Modify
Assistant Request_ Tool Resources_ File Search - Modify
Certificate Request - Modify
Message Request - Modify
RunRequest - Modify
Thread Request - Modify
Thread Request_ Tool Resources - A set of resources that are made available to the assistant’s tools in this thread.
- Modify
Thread Request_ Tool Resources_ Code Interpreter - Modify
Thread Request_ Tool Resources_ File Search - Move
- A mouse move action.
- OpenAI
File - The
Fileobject represents a document that has been uploaded to OpenAI. - Other
Chunking Strategy Response Param - This is returned when the chunking strategy is unknown.
- Output
Audio - An audio output from the model.
- Output
Message - An output message from the model.
- Output
Text Content - A text output from the model.
- Prediction
Content - Static predicted output content, such as the content of a text file that is being regenerated.
- Project
- Represents an individual project.
- Project
ApiKey - Represents an individual API key in a project.
- Project
ApiKey Delete Response - Project
ApiKey List Response - Project
ApiKey_ Owner - Project
Create Request - Project
List Response - Project
Rate Limit - Represents a project rate limit config.
- Project
Rate Limit List Response - Project
Rate Limit Update Request - Project
Service Account - Represents an individual service account in a project.
- Project
Service Account ApiKey - Project
Service Account Create Request - Project
Service Account Create Response - Project
Service Account Delete Response - Project
Service Account List Response - Project
Update Request - Project
User - Represents an individual user in a project.
- Project
User Create Request - Project
User Delete Response - Project
User List Response - Project
User Update Request - Ranking
Options - Realtime
Client Event Conversation Item Create - Add a new Item to the Conversation’s context, including messages, function calls, and function call responses.
- Realtime
Client Event Conversation Item Delete - Send this event when you want to remove any item from the conversation history.
- Realtime
Client Event Conversation Item Retrieve - Send this event when you want to retrieve the server’s representation of a specific item in the conversation history.
- Realtime
Client Event Conversation Item Truncate - Send this event to truncate a previous assistant message’s audio.
- Realtime
Client Event Input Audio Buffer Append - Send this event to append audio bytes to the input audio buffer.
- Realtime
Client Event Input Audio Buffer Clear - Send this event to clear the audio bytes in the buffer.
- Realtime
Client Event Input Audio Buffer Commit - Send this event to commit the user input audio buffer, which will create a new user message item in the conversation.
- Realtime
Client Event Output Audio Buffer Clear - WebRTC Only: Emit to cut off the current audio response.
- Realtime
Client Event Response Cancel - Send this event to cancel an in-progress response.
- Realtime
Client Event Response Create - This event instructs the server to create a Response, which means triggering model inference.
- Realtime
Client Event Session Update - Send this event to update the session’s default configuration.
- Realtime
Client Event Transcription Session Update - Send this event to update a transcription session.
- Realtime
Conversation Item - The item to add to the conversation.
- Realtime
Conversation Item With Reference - The item to add to the conversation.
- Realtime
Conversation Item With Reference_ Content - Realtime
Conversation Item_ Content - Realtime
Response - The response resource.
- Realtime
Response Create Params - Create a new Realtime response with these parameters
- Realtime
Response Create Params_ Tools - Realtime
Response Create Params_ Tools_ Parameters - Parameters of the function in JSON Schema.
- Realtime
Response_ Status Details - Additional details about the status.
- Realtime
Response_ Status Details_ Error - A description of the error that caused the response to fail, populated when
the
statusisfailed. - Realtime
Response_ Usage - Usage statistics for the Response, this will correspond to billing.
- Realtime
Response_ Usage_ Input Token Details - Details about the input tokens used in the Response.
- Realtime
Response_ Usage_ Output Token Details - Details about the output tokens used in the Response.
- Realtime
Server Event Conversation Created - Returned when a conversation is created.
- Realtime
Server Event Conversation Created_ Conversation - The conversation resource.
- Realtime
Server Event Conversation Item Created - Returned when a conversation item is created.
- Realtime
Server Event Conversation Item Deleted - Returned when an item in the conversation is deleted by the client with a
conversation.item.deleteevent. - Realtime
Server Event Conversation Item Input Audio Transcription Completed - This event is the output of audio transcription for user audio written to the user audio buffer.
- Realtime
Server Event Conversation Item Input Audio Transcription Delta - Returned when the text value of an input audio transcription content part is updated.
- Realtime
Server Event Conversation Item Input Audio Transcription Failed - Returned when input audio transcription is configured, and a transcription request for a user message failed.
- Realtime
Server Event Conversation Item Input Audio Transcription Failed_ Error - Details of the transcription error.
- Realtime
Server Event Conversation Item Retrieved - Returned when a conversation item is retrieved with
conversation.item.retrieve. - Realtime
Server Event Conversation Item Truncated - Returned when an earlier assistant audio message item is truncated by the
client with a
conversation.item.truncateevent. - Realtime
Server Event Error - Returned when an error occurs, which could be a client problem or a server problem.
- Realtime
Server Event Error_ Error - Details of the error.
- Realtime
Server Event Input Audio Buffer Cleared - Returned when the input audio buffer is cleared by the client with a
input_audio_buffer.clearevent. - Realtime
Server Event Input Audio Buffer Committed - Returned when an input audio buffer is committed, either by the client or automatically in server VAD mode.
- Realtime
Server Event Input Audio Buffer Speech Started - Sent by the server when in
server_vadmode to indicate that speech has been detected in the audio buffer. - Realtime
Server Event Input Audio Buffer Speech Stopped - Returned in
server_vadmode when the server detects the end of speech in the audio buffer. - Realtime
Server Event Output Audio Buffer Cleared - WebRTC Only: Emitted when the output audio buffer is cleared.
- Realtime
Server Event Output Audio Buffer Started - WebRTC Only: Emitted when the server begins streaming audio to the client.
- Realtime
Server Event Output Audio Buffer Stopped - WebRTC Only: Emitted when the output audio buffer has been completely drained on the server, and no more audio is forthcoming.
- Realtime
Server Event Rate Limits Updated - Emitted at the beginning of a Response to indicate the updated rate limits.
- Realtime
Server Event Rate Limits Updated_ Rate Limits - Realtime
Server Event Response Audio Delta - Returned when the model-generated audio is updated.
- Realtime
Server Event Response Audio Done - Returned when the model-generated audio is done.
- Realtime
Server Event Response Audio Transcript Delta - Returned when the model-generated transcription of audio output is updated.
- Realtime
Server Event Response Audio Transcript Done - Returned when the model-generated transcription of audio output is done streaming.
- Realtime
Server Event Response Content Part Added - Returned when a new content part is added to an assistant message item during response generation.
- Realtime
Server Event Response Content Part Added_ Part - The content part that was added.
- Realtime
Server Event Response Content Part Done - Returned when a content part is done streaming in an assistant message item.
- Realtime
Server Event Response Content Part Done_ Part - The content part that is done.
- Realtime
Server Event Response Created - Returned when a new Response is created.
- Realtime
Server Event Response Done - Returned when a Response is done streaming.
- Realtime
Server Event Response Function Call Arguments Delta - Returned when the model-generated function call arguments are updated.
- Realtime
Server Event Response Function Call Arguments Done - Returned when the model-generated function call arguments are done streaming.
- Realtime
Server Event Response Output Item Added - Returned when a new Item is created during Response generation.
- Realtime
Server Event Response Output Item Done - Returned when an Item is done streaming.
- Realtime
Server Event Response Text Delta - Returned when the text value of a “text” content part is updated.
- Realtime
Server Event Response Text Done - Returned when the text value of a “text” content part is done streaming.
- Realtime
Server Event Session Created - Returned when a Session is created.
- Realtime
Server Event Session Updated - Returned when a session is updated with a
session.updateevent, unless there is an error. - Realtime
Server Event Transcription Session Updated - Returned when a transcription session is updated with a
transcription_session.updateevent, unless there is an error. - Realtime
Session - Realtime session object configuration.
- Realtime
Session Create Request - Realtime session object configuration.
- Realtime
Session Create Request_ Input Audio Noise Reduction - Configuration for input audio noise reduction.
- Realtime
Session Create Request_ Input Audio Transcription - Configuration for input audio transcription, defaults to off and can be set
to
nullto turn off once on. - Realtime
Session Create Request_ Tools - Realtime
Session Create Request_ Tools_ Parameters - Parameters of the function in JSON Schema.
- Realtime
Session Create Request_ Turn Detection - Configuration for turn detection, ether Server VAD or Semantic VAD.
- Realtime
Session Create Response - A new Realtime session configuration, with an ephermeral key.
- Realtime
Session Create Response_ Client Secret - Ephemeral key returned by the API.
- Realtime
Session Create Response_ Input Audio Transcription - Configuration for input audio transcription, defaults to off and can be set
to
nullto turn off once on. - Realtime
Session Create Response_ Tools - Realtime
Session Create Response_ Tools_ Parameters - Parameters of the function in JSON Schema.
- Realtime
Session Create Response_ Turn Detection - Configuration for turn detection.
- Realtime
Session_ Input Audio Noise Reduction - Configuration for input audio noise reduction.
- Realtime
Session_ Input Audio Transcription - Configuration for input audio transcription, defaults to off and can be set
to
nullto turn off once on. - Realtime
Session_ Tools - Realtime
Session_ Tools_ Parameters - Parameters of the function in JSON Schema.
- Realtime
Session_ Turn Detection - Configuration for turn detection, ether Server VAD or Semantic VAD.
- Realtime
Transcription Session Create Request - Realtime transcription session object configuration.
- Realtime
Transcription Session Create Request_ Input Audio Noise Reduction - Configuration for input audio noise reduction.
- Realtime
Transcription Session Create Request_ Input Audio Transcription - Configuration for input audio transcription.
- Realtime
Transcription Session Create Request_ Turn Detection - Configuration for turn detection, ether Server VAD or Semantic VAD.
- Realtime
Transcription Session Create Response - A new Realtime transcription session configuration.
- Realtime
Transcription Session Create Response_ Client Secret - Ephemeral key returned by the API.
- Realtime
Transcription Session Create Response_ Input Audio Transcription - Configuration of the transcription model.
- Realtime
Transcription Session Create Response_ Turn Detection - Configuration for turn detection.
- Reasoning
- o-series models only Configuration options for reasoning models.
- Reasoning
Item - A description of the chain of thought used by a reasoning model while generating a response.
- Reasoning
Item_ Summary - Refusal
Content - A refusal from the model.
- Response
- Response
Audio Delta Event - Emitted when there is a partial audio response.
- Response
Audio Done Event - Emitted when the audio response is complete.
- Response
Audio Transcript Delta Event - Emitted when there is a partial transcript of audio.
- Response
Audio Transcript Done Event - Emitted when the full audio transcript is completed.
- Response
Code Interpreter Call Code Delta Event - Emitted when a partial code snippet is added by the code interpreter.
- Response
Code Interpreter Call Code Done Event - Emitted when code snippet output is finalized by the code interpreter.
- Response
Code Interpreter Call Completed Event - Emitted when the code interpreter call is completed.
- Response
Code Interpreter Call InProgress Event - Emitted when a code interpreter call is in progress.
- Response
Code Interpreter Call Interpreting Event - Emitted when the code interpreter is actively interpreting the code snippet.
- Response
Completed Event - Emitted when the model response is complete.
- Response
Content Part Added Event - Emitted when a new content part is added.
- Response
Content Part Done Event - Emitted when a content part is done.
- Response
Created Event - An event that is emitted when a response is created.
- Response
Error - An error object returned when the model fails to generate a Response.
- Response
Error Event - Emitted when an error occurs.
- Response
Failed Event - An event that is emitted when a response fails.
- Response
File Search Call Completed Event - Emitted when a file search call is completed (results found).
- Response
File Search Call InProgress Event - Emitted when a file search call is initiated.
- Response
File Search Call Searching Event - Emitted when a file search is currently searching.
- Response
Format Json Object - JSON object response format.
- Response
Format Json Schema - JSON Schema response format.
- Response
Format Json Schema Schema - The schema for the response format, described as a JSON Schema object.
- Response
Format Json Schema_ Json Schema - Structured Outputs configuration options, including a JSON Schema.
- Response
Format Text - Default response format.
- Response
Function Call Arguments Delta Event - Emitted when there is a partial function-call arguments delta.
- Response
Function Call Arguments Done Event - Emitted when function-call arguments are finalized.
- Response
InProgress Event - Emitted when the response is in progress.
- Response
Incomplete Event - An event that is emitted when a response finishes as incomplete.
- Response
Item List - A list of Response items.
- Response
Output Item Added Event - Emitted when a new output item is added.
- Response
Output Item Done Event - Emitted when an output item is marked done.
- Response
Properties - Response
Properties_ Text - Configuration options for a text response from the model.
- Response
Reasoning Summary Part Added Event - Emitted when a new reasoning summary part is added.
- Response
Reasoning Summary Part Added Event_ Part - The summary part that was added.
- Response
Reasoning Summary Part Done Event - Emitted when a reasoning summary part is completed.
- Response
Reasoning Summary Part Done Event_ Part - The completed summary part.
- Response
Reasoning Summary Text Delta Event - Emitted when a delta is added to a reasoning summary text.
- Response
Reasoning Summary Text Done Event - Emitted when a reasoning summary text is completed.
- Response
Refusal Delta Event - Emitted when there is a partial refusal text.
- Response
Refusal Done Event - Emitted when refusal text is finalized.
- Response
Text Annotation Delta Event - Emitted when a text annotation is added.
- Response
Text Delta Event - Emitted when there is an additional text delta.
- Response
Text Done Event - Emitted when text content is finalized.
- Response
Usage - Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.
- Response
Usage_ Input Tokens Details - A detailed breakdown of the input tokens.
- Response
Usage_ Output Tokens Details - A detailed breakdown of the output tokens.
- Response
WebSearch Call Completed Event - Emitted when a web search call is completed.
- Response
WebSearch Call InProgress Event - Emitted when a web search call is initiated.
- Response
WebSearch Call Searching Event - Emitted when a web search call is executing.
- Response_
Variant3 - Response_
Variant3_ Incomplete Details - Details about why the response is incomplete.
- RunCompletion
Usage - Usage statistics related to the run.
- RunObject
- Represents an execution run on a thread.
- RunObject_
Incomplete Details - Details on why the run is incomplete.
- RunObject_
Last Error - The last error associated with this run.
- RunObject_
Required Action - Details on the action required to continue the run.
- RunObject_
Required Action_ Submit Tool Outputs - Details on the tool outputs needed for this run to continue.
- RunStep
Completion Usage - Usage statistics related to the run step.
- RunStep
Delta Object - Represents a run step delta i.e.
- RunStep
Delta Object_ Delta - The delta containing the fields that have changed on the run step.
- RunStep
Delta Step Details Message Creation Object - Details of the message creation by the run step.
- RunStep
Delta Step Details Message Creation Object_ Message Creation - RunStep
Delta Step Details Tool Calls Code Object - Details of the Code Interpreter tool call the run step was involved in.
- RunStep
Delta Step Details Tool Calls Code Object_ Code Interpreter - The Code Interpreter tool call definition.
- RunStep
Delta Step Details Tool Calls Code Output Image Object - RunStep
Delta Step Details Tool Calls Code Output Image Object_ Image - RunStep
Delta Step Details Tool Calls Code Output Logs Object - Text output from the Code Interpreter tool call as part of a run step.
- RunStep
Delta Step Details Tool Calls File Search Object - RunStep
Delta Step Details Tool Calls File Search Object_ File Search - For now, this is always going to be an empty object.
- RunStep
Delta Step Details Tool Calls Function Object - RunStep
Delta Step Details Tool Calls Function Object_ Function - The definition of the function that was called.
- RunStep
Delta Step Details Tool Calls Object - Details of the tool call.
- RunStep
Details Message Creation Object - Details of the message creation by the run step.
- RunStep
Details Message Creation Object_ Message Creation - RunStep
Details Tool Calls Code Object - Details of the Code Interpreter tool call the run step was involved in.
- RunStep
Details Tool Calls Code Object_ Code Interpreter - The Code Interpreter tool call definition.
- RunStep
Details Tool Calls Code Output Image Object - RunStep
Details Tool Calls Code Output Image Object_ Image - RunStep
Details Tool Calls Code Output Logs Object - Text output from the Code Interpreter tool call as part of a run step.
- RunStep
Details Tool Calls File Search Object - RunStep
Details Tool Calls File Search Object_ File Search - For now, this is always going to be an empty object.
- RunStep
Details Tool Calls File Search Ranking Options Object - The ranking options for the file search.
- RunStep
Details Tool Calls File Search Result Object - A result instance of the file search.
- RunStep
Details Tool Calls File Search Result Object_ Content - RunStep
Details Tool Calls Function Object - RunStep
Details Tool Calls Function Object_ Function - The definition of the function that was called.
- RunStep
Details Tool Calls Object - Details of the tool call.
- RunStep
Object - Represents a step in execution of a run.
- RunStep
Object_ Last Error - The last error associated with this run step.
- RunStep
Stream Event_ Variant1 - Occurs when a run step is created.
- RunStep
Stream Event_ Variant2 - Occurs when a run step moves to
an
in_progressstate. - RunStep
Stream Event_ Variant3 - Occurs when parts of a run step are being streamed.
- RunStep
Stream Event_ Variant4 - Occurs when a run step is completed.
- RunStep
Stream Event_ Variant5 - Occurs when a run step fails.
- RunStep
Stream Event_ Variant6 - Occurs when a run step is cancelled.
- RunStep
Stream Event_ Variant7 - Occurs when a run step expires.
- RunStream
Event_ Variant1 - Occurs when a new run is created.
- RunStream
Event_ Variant2 - Occurs when a run moves to a
queuedstatus. - RunStream
Event_ Variant3 - Occurs when a run moves to an
in_progressstatus. - RunStream
Event_ Variant4 - Occurs when a run moves to a
requires_actionstatus. - RunStream
Event_ Variant5 - Occurs when a run is completed.
- RunStream
Event_ Variant6 - Occurs when a run ends with status
incomplete. - RunStream
Event_ Variant7 - Occurs when a run fails.
- RunStream
Event_ Variant8 - Occurs when a run moves to a
cancellingstatus. - RunStream
Event_ Variant9 - Occurs when a run is cancelled.
- RunStream
Event_ Variant10 - Occurs when a run expires.
- RunTool
Call Object - Tool call objects
- RunTool
Call Object_ Function - The function definition.
- Screenshot
- A screenshot action.
- Scroll
- A scroll action.
- Static
Chunking Strategy - Static
Chunking Strategy Request Param - Customize your own chunking strategy by setting chunk size and chunk overlap.
- Static
Chunking Strategy Response Param - Submit
Tool Outputs RunRequest - Submit
Tool Outputs RunRequest_ Tool Outputs - Text
Response Format Json Schema - JSON Schema response format.
- Thread
Object - Represents a thread that contains messages.
- Thread
Object_ Tool Resources - A set of resources that are made available to the assistant’s tools in this thread.
- Thread
Object_ Tool Resources_ Code Interpreter - Thread
Object_ Tool Resources_ File Search - Toggle
Certificates Request - Tool
Choice Function - Use this option to force the model to call a specific function.
- Tool
Choice Types - Indicates that the model should use a built-in tool to generate a response.
- Transcript
Text Delta Event - Emitted when there is an additional text delta.
- Transcript
Text Delta Event_ Logprobs - Transcript
Text Done Event - Emitted when the transcription is complete.
- Transcript
Text Done Event_ Logprobs - Transcription
Segment - Transcription
Word - Truncation
Object - Controls for how a thread will be truncated prior to the run.
- Type
- An action to type in text.
- Update
Vector Store File Attributes Request - Update
Vector Store Request - Upload
- The Upload object can accept byte chunks in the form of Parts.
- Upload
Certificate Request - Upload
Part - The upload Part represents a chunk of bytes we can add to an Upload object.
- UrlCitation
Body - A citation for a web resource used to generate a model response.
- Usage
Audio Speeches Result - The aggregated audio speeches usage details of the specific time bucket.
- Usage
Audio Transcriptions Result - The aggregated audio transcriptions usage details of the specific time bucket.
- Usage
Code Interpreter Sessions Result - The aggregated code interpreter sessions usage details of the specific time bucket.
- Usage
Completions Result - The aggregated completions usage details of the specific time bucket.
- Usage
Embeddings Result - The aggregated embeddings usage details of the specific time bucket.
- Usage
Images Result - The aggregated images usage details of the specific time bucket.
- Usage
Moderations Result - The aggregated moderations usage details of the specific time bucket.
- Usage
Response - Usage
Time Bucket - Usage
Vector Stores Result - The aggregated vector stores usage details of the specific time bucket.
- User
- Represents an individual
userwithin an organization. - User
Delete Response - User
List Response - User
Role Update Request - Vector
Store Expiration After - The expiration policy for a vector store.
- Vector
Store File Attributes - Set of 16 key-value pairs that can be attached to an object.
- Vector
Store File Batch Object - A batch of files attached to a vector store.
- Vector
Store File Batch Object_ File Counts - Vector
Store File Content Response - Represents the parsed content of a vector store file.
- Vector
Store File Content Response_ Data - Vector
Store File Object - A list of files attached to a vector store.
- Vector
Store File Object_ Last Error - The last error associated with this vector store file.
- Vector
Store Object - A vector store is a collection of processed files can be used by the
file_searchtool. - Vector
Store Object_ File Counts - Vector
Store Search Request - Vector
Store Search Request_ Ranking Options - Ranking options for search.
- Vector
Store Search Result Content Object - Vector
Store Search Result Item - Vector
Store Search Results Page - Wait
- A wait action.
- WebSearch
Location - Approximate location parameters for the search.
- WebSearch
Preview Tool - This tool searches the web for relevant results to use in a response.
- WebSearch
Tool Call - The results of a web search tool call.
Enums§
- Annotation
- Assistant
Object_ Tools - Assistant
Stream Event - Represents an event emitted when streaming a Run.
- Assistant
Supported Models - Assistants
ApiResponse Format Option - Specifies the format that the model must output.
- Assistants
ApiTool Choice Option - Controls which (if any) tool is called by the model.
- Audio
Response Format - The format of the output, in one of these options:
json,text,srt,verbose_json, orvtt. - Audit
LogEvent Type - The event type.
- Chat
Completion Request Assistant Message Content Part - Chat
Completion Request Assistant Message_ Content - The contents of the assistant message.
- Chat
Completion Request Developer Message_ Content - The contents of the developer message.
- Chat
Completion Request Message - Chat
Completion Request System Message_ Content - The contents of the system message.
- Chat
Completion Request Tool Message_ Content - The contents of the tool message.
- Chat
Completion Request User Message Content Part - Chat
Completion Request User Message_ Content - The contents of the user message.
- Chat
Completion Role - The role of the author of a message
- Chat
Completion Tool Choice Option - Controls which (if any) tool is called by the model.
- Chunking
Strategy Request Param - The chunking strategy used to chunk the file(s).
- Code
Interpreter Tool Output - Comparison
Filter_ Value - The value to compare against the attribute key; supports string, number, or boolean types.
- Computer
Action - Content
- Multi-modal input and output contents.
- Create
Assistant Request_ Model - ID of the model to use.
- Create
Assistant Request_ Tools - Create
Chat Completion Request_ Variant2_ Function Call - Deprecated in favor of
tool_choice. - Create
Chat Completion Request_ Variant2_ Response Format - An object specifying the format that the model must output.
- Create
Completion Request_ Prompt - The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.
- Create
Embedding Request_ Input - Input text to embed, encoded as a string or array of tokens.
- Create
Eval Completions RunData Source_ Input Messages - Create
Eval Completions RunData Source_ Input Messages_ Variant1_ Template - Create
Eval Completions RunData Source_ Source - Create
Eval Item - A chat message that makes up the prompt or context.
- Create
Eval Jsonl RunData Source_ Source - Create
Eval Request_ Data Source Config - The configuration for the data source used for the evaluation runs.
- Create
Eval Request_ Testing Criteria - Create
Eval Responses RunData Source_ Input Messages - Create
Eval Responses RunData Source_ Input Messages_ Variant1_ Template - Create
Eval Responses RunData Source_ Source - Create
Eval RunRequest_ Data Source - Details about the run’s data source.
- Create
Fine Tuning JobRequest_ Hyperparameters_ Batch Size - Number of examples in each batch.
- Create
Fine Tuning JobRequest_ Hyperparameters_ Learning Rate Multiplier - Scaling factor for the learning rate.
- Create
Fine Tuning JobRequest_ Hyperparameters_ NEpochs - The number of epochs to train the model for.
- Create
Fine Tuning JobRequest_ Integrations_ Type - Create
Image Edit Request_ Image - The image(s) to edit.
- Create
Message Request_ Attachments_ Tools - Create
Message Request_ Content - Create
Message Request_ Content_ Variant2 - Create
Moderation Request_ Input - Input (or inputs) to classify.
- Create
Moderation Request_ Input_ Variant3 - Create
Response_ Variant3_ Input - Text, image, or file inputs to the model, used to generate a response.
- Create
RunRequest_ Model - The ID of the Model to be used to execute this run.
- Create
RunRequest_ Tools - Create
Thread AndRun Request_ Tools - Create
Transcription Response Stream Event - Create
Vector Store Request_ Chunking Strategy - The chunking strategy used to chunk the file(s).
- Easy
Input Message_ Content - Text, image, or audio input to the model, used to generate a response.
- Eval
Item_ Content - Text inputs to the model - can contain template strings.
- Eval
Run_ Data Source - Information about the run’s data source.
- Eval_
Data Source Config - Configuration of data sources used in runs of the evaluation.
- Eval_
Testing Criteria - File
Search Ranker - The ranker to use for the file search.
- Filters
- Fine
Tune Chat Request Input_ Messages - Fine
TuneDPO Method_ Hyperparameters_ Batch Size - Number of examples in each batch.
- Fine
TuneDPO Method_ Hyperparameters_ Beta - The beta value for the DPO method.
- Fine
TuneDPO Method_ Hyperparameters_ Learning Rate Multiplier - Scaling factor for the learning rate.
- Fine
TuneDPO Method_ Hyperparameters_ NEpochs - The number of epochs to train the model for.
- Fine
Tune Preference Request Input_ Input_ Messages - Fine
Tune Supervised Method_ Hyperparameters_ Batch Size - Number of examples in each batch.
- Fine
Tune Supervised Method_ Hyperparameters_ Learning Rate Multiplier - Scaling factor for the learning rate.
- Fine
Tune Supervised Method_ Hyperparameters_ NEpochs - The number of epochs to train the model for.
- Fine
Tuning Job_ Hyperparameters_ Batch Size - Number of examples in each batch.
- Fine
Tuning Job_ Hyperparameters_ Learning Rate Multiplier - Scaling factor for the learning rate.
- Fine
Tuning Job_ Hyperparameters_ NEpochs - The number of epochs to train the model for.
- Includable
- Specify additional output data to include in the model response.
- Input
Content - Input
Item - Item
- Content item used to generate a response.
- Item
Resource - Content item used to generate a response.
- Message
Content Text Object_ Text_ Annotations - Message
Delta Content Text Object_ Text_ Annotations - Message
Delta Object_ Delta_ Content - Message
Object_ Attachments_ Tools - Message
Object_ Content - Message
Stream Event - Model
Ids - Model
IdsResponses - Modify
Assistant Request_ Model - ID of the model to use.
- Modify
Assistant Request_ Tools - Output
Content - Output
Item - Prediction
Content_ Content - The content that should be matched when generating a model response.
- Realtime
Client Event - A realtime client event.
- Realtime
Response Create Params_ MaxResponse Output Tokens - Maximum number of output tokens for a single assistant response, inclusive of tool calls.
- Realtime
Response_ MaxOutput Tokens - Maximum number of output tokens for a single assistant response, inclusive of tool calls, that was used in this response.
- Realtime
Server Event - A realtime server event.
- Realtime
Session Create Request_ MaxResponse Output Tokens - Maximum number of output tokens for a single assistant response, inclusive of tool calls.
- Realtime
Session Create Response_ MaxResponse Output Tokens - Maximum number of output tokens for a single assistant response, inclusive of tool calls.
- Realtime
Session_ MaxResponse Output Tokens - Maximum number of output tokens for a single assistant response, inclusive of tool calls.
- Reasoning
Effort - o-series models only Constrains effort on reasoning for reasoning models.
- Response
Error Code - The error code for the response.
- Response
Properties_ Tool Choice - How the model should select which tool (or tools) to use when generating a response.
- Response
Stream Event - RunObject_
Tools - RunStep
Delta Object_ Delta_ Step Details - The details of the run step.
- RunStep
Delta Step Details Tool Calls Code Object_ Code Interpreter_ Outputs - RunStep
Delta Step Details Tool Calls Object_ Tool Calls - RunStep
Details Tool Calls Code Object_ Code Interpreter_ Outputs - RunStep
Details Tool Calls Object_ Tool Calls - RunStep
Object_ Step Details - The details of the run step.
- RunStep
Stream Event - RunStream
Event - Service
Tier - Specifies the latency tier to use for processing the request.
- Stop
Configuration - Not supported with latest reasoning models
o3ando4-mini. - Text
Response Format Configuration - An object specifying the format that the model must output.
- Thread
Stream Event - Tool
- Tool
Choice Options - Controls which (if any) tool is called by the model.
- Transcription
Include - Usage
Time Bucket_ Result - Vector
Store File Object_ Chunking Strategy - The strategy used to chunk the file.
- Vector
Store Search Request_ Filters - A filter to apply based on file attributes.
- Vector
Store Search Request_ Query - A query string for a search
- WebSearch
Context Size - High level guidance for the amount of context window space to use for the search.
Type Aliases§
- Approximate
Location_ City - Approximate
Location_ Country - Approximate
Location_ Region - Approximate
Location_ Timezone - Chat
Completion Message Tool Calls - The tool calls generated by the model, such as function calls.
- Chat
Completion Modalities - Output types that you would like the model to generate for this request.
- Computer
Call Output Item Param_ Acknowledged Safety Checks - Computer
Call Output Item Param_ Acknowledged Safety Checks_ 1 - The safety checks reported by the API that have been acknowledged by the developer.
- Computer
Call Output Item Param_ Id - Computer
Call Output Item Param_ Status - Computer
Call Safety Check Param_ Code - Computer
Call Safety Check Param_ Message - Create
Completion Request_ Model - ID of the model to use.
- Create
Embedding Request_ Model - ID of the model to use.
- Create
Fine Tuning JobRequest_ Model - The name of the model to fine-tune.
- Create
Image Edit Request_ Model - The model to use for image generation.
- Create
Image Request_ Model - The model to use for image generation.
- Create
Image Variation Request_ Model - The model to use for image generation.
- Create
Moderation Request_ Model - The content moderation model you would like to use.
- Create
Speech Request_ Model - One of the available TTS models:
tts-1,tts-1-hdorgpt-4o-mini-tts. - Create
Thread AndRun Request_ Model - The ID of the Model to be used to execute this run.
- Create
Transcription Request_ Model - ID of the model to use.
- Create
Translation Request_ Model - ID of the model to use.
- File
Search Tool_ Filters - File
Search Tool_ Filters_ 1 - A filter to apply.
- Function
Call Output Item Param_ Id - Function
Call Output Item Param_ Status - Function
Tool_ Description - Function
Tool_ Parameters - Function
Tool_ Strict - Function
Tool_ Strict_ 1 - Whether to enforce strict parameter validation.
- Input
File Content_ File Id - Input
Image Content_ File Id - Input
Image Content_ Image Url - Input
Message Content List - A list of one or many input items to the model, containing different content types.
- Item
Reference Param_ Type - Model
IdsShared - Parallel
Tool Calls - Whether to enable parallel function calling during tool use.
- Realtime
Response Create Params_ Conversation - Controls which conversation the response is added to.
- Response
Modalities - Output types that you would like the model to generate.
- Voice
IdsShared - WebSearch
Preview Tool_ User Location - WebSearch
Preview Tool_ User Location_ 1 - The user’s location.