generated: '2026-10-13' method: derived generator: derive-vocabulary.py source: - openapi/openai-agents-api-openapi.yml - openapi/openai-assistants-api-openapi.yml - openapi/openai-audio-api-openapi.yml - openapi/openai-audit-logs-api-openapi.yml - openapi/openai-batch-api-openapi.yml vocabulary: name: OpenAI Domain Vocabulary description: 'Terms declared by OpenAI''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions. Derived, not authored.' version: '2026-10-13' terms: - term: Assistants definition: Build Assistants that can call models and use tools. tags: - Resource Group source: openapi/openai-assistants-api-openapi.yml - term: Audio definition: Turn audio into text or text into audio. tags: - Resource Group source: openapi/openai-audio-api-openapi.yml - term: Audit Logs definition: List user actions and configuration changes within this organization. tags: - Resource Group source: openapi/openai-audit-logs-api-openapi.yml - term: Batch definition: Create large batches of API requests to run asynchronously. tags: - Resource Group source: openapi/openai-batch-api-openapi.yml - term: Chat Completions definition: Given a list of messages comprising a conversation, the model will return a response. tags: - Resource Group source: openapi/openai-chat-completions-api-openapi.yml - term: Completions definition: Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. tags: - Resource Group source: openapi/openai-completions-api-openapi.yml - term: Conversations definition: Manage conversations and conversation items. tags: - Resource Group source: openapi/openai-conversations-api-openapi.yml - term: Embeddings definition: Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. tags: - Resource Group source: openapi/openai-embeddings-api-openapi.yml - term: Evals definition: Manage and run evals in the OpenAI platform. tags: - Resource Group source: openapi/openai-evals-api-openapi.yml - term: Files definition: Files are used to upload documents that can be used with features like Assistants and Fine-tuning. tags: - Resource Group source: openapi/openai-files-api-openapi.yml - term: Fine Tuning definition: Manage fine-tuning jobs to tailor a model to your specific training data. tags: - Resource Group source: openapi/openai-fine-tuning-api-openapi.yml - term: Images definition: Given a prompt and/or an input image, the model will generate a new image. tags: - Resource Group source: openapi/openai-images-api-openapi.yml - term: Models definition: List and describe the various models available in the API. tags: - Resource Group source: openapi/openai-models-api-openapi.yml - term: Moderations definition: Given text and/or image inputs, classifies if those inputs are potentially harmful. tags: - Resource Group source: openapi/openai-moderations-api-openapi.yml - term: Responses definition: Create and manage model responses. tags: - Resource Group source: openapi/openai-responses-api-openapi.yml - term: Uploads definition: Use Uploads to upload large files in multiple parts. tags: - Resource Group source: openapi/openai-uploads-api-openapi.yml - term: EnvironmentTemplateListResource definition: A page of Agents API resources, with IDs for retrieving additional pages. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/EnvironmentTemplateListResource - term: AgentToolConfigParamWebSearch definition: Web search. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/AgentToolConfigParamWebSearch - term: SessionEventAgentSessionTurnContentPartAdded definition: Emitted when an output text content part is added. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionEventAgentSessionTurnContentPartAdded - term: InterruptSubagentCallItemResource definition: A request to interrupt a subagent's current turn. The subagent remains available. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/InterruptSubagentCallItemResource - term: InputContentParamInputText definition: Text input to the model. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/InputContentParamInputText - term: McpTransportResource definition: The transport used to connect to an MCP server. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/McpTransportResource - term: HostedEnvironmentFileResourceFileId definition: A file copied from the OpenAI Files API. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/HostedEnvironmentFileResourceFileId - term: InlineCapabilitySourceParam definition: The encoded ZIP archive for an inline skill or plugin. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/InlineCapabilitySourceParam - term: FunctionCallItemResource definition: A function call produced by the agent. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/FunctionCallItemResource - term: CreateEnvironmentTemplateParams definition: Parameters for creating a reusable, project-scoped OpenAI-hosted environment template. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/CreateEnvironmentTemplateParams - term: SessionStatusResource definition: The current status of a session. tags: - Enumeration source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionStatusResource - term: SessionEventAgentSessionTurnReasoningSummaryTextDelta definition: Emitted when text is appended to a reasoning summary. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDelta - term: UpdateSessionAgentParam definition: Model settings that can change after session creation. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/UpdateSessionAgentParam - term: HostedPluginResourceInline definition: A plugin installed from an inline ZIP archive. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/HostedPluginResourceInline - term: TurnStatusResource definition: The current status of a turn. tags: - Enumeration source: openapi/openai-agents-api-openapi.yml#/components/schemas/TurnStatusResource - term: SessionEventError definition: Emitted when a turn or session fails. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionEventError - term: McpTransportResourceStdio definition: Starts an MCP server as a local process. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/McpTransportResourceStdio - term: SubagentObjectResource definition: The object type for a subagent. tags: - Enumeration source: openapi/openai-agents-api-openapi.yml#/components/schemas/SubagentObjectResource - term: VerbosityResource definition: The amount of text produced by an agent. tags: - Enumeration source: openapi/openai-agents-api-openapi.yml#/components/schemas/VerbosityResource - term: TextFormatResourceText definition: Generates ordinary text without a structured-output constraint. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/TextFormatResourceText - term: SessionTurnListResource definition: A page of Agents API resources, with IDs for retrieving additional pages. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionTurnListResource - term: SessionTurnErrorResource definition: A customer-safe error describing why a session request failed. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionTurnErrorResource - term: AgentToolConfigParamFunction definition: A function defined by the application. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/AgentToolConfigParamFunction - term: InputContentResource definition: User-provided content recorded in a session item. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/InputContentResource - term: InputContentResourceInputImage definition: Image input recorded in a session item. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/InputContentResourceInputImage - term: TextFormatResourceJsonSchema definition: Constrains generated text to a JSON Schema. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/TextFormatResourceJsonSchema - term: McpConnectionOriginParam definition: Where outbound MCP HTTP connections originate. tags: - Enumeration source: openapi/openai-agents-api-openapi.yml#/components/schemas/McpConnectionOriginParam - term: WebSearchContextSizeParam definition: The amount of web search context made available to the model. tags: - Enumeration source: openapi/openai-agents-api-openapi.yml#/components/schemas/WebSearchContextSizeParam - term: SessionEventAgentSessionTurnItemDone definition: Emitted when an output item is complete. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionEventAgentSessionTurnItemDone - term: MessagePhaseResource definition: The phase of an assistant message. tags: - Enumeration source: openapi/openai-agents-api-openapi.yml#/components/schemas/MessagePhaseResource - term: ErrorResponse-2 definition: An API error response. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/ErrorResponse-2 - term: SessionInputParam definition: Input submitted to an existing session. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionInputParam - term: SessionEventAgentSessionTurnReasoningSummaryPartAdded definition: Emitted when a reasoning summary content part is added. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartAdded - term: SessionEnvironmentStatusResource definition: The connection status of a session environment. tags: - Enumeration source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionEnvironmentStatusResource - term: SessionEventAgentSessionTurnReasoningSummaryTextDone definition: Emitted when a reasoning summary content part is complete. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDone - term: InputContentParam definition: Content included in an input message. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/InputContentParam - term: HostedPluginParam definition: A plugin installed in an OpenAI-hosted environment. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/HostedPluginParam - term: EnvironmentStatusResource definition: The public lifecycle status of an execution environment. tags: - Enumeration source: openapi/openai-agents-api-openapi.yml#/components/schemas/EnvironmentStatusResource - term: ErrorBodyResource definition: Details about an API error. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/ErrorBodyResource - term: OutputTokensDetailsResource definition: A breakdown of output token usage for a session or turn. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/OutputTokensDetailsResource - term: NetworkAccessParam definition: The network access mode for an OpenAI-hosted environment. tags: - Enumeration source: openapi/openai-agents-api-openapi.yml#/components/schemas/NetworkAccessParam - term: SessionEvent definition: An event emitted by a Managed Agents session. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionEvent - term: SessionEventAgentSessionCreated definition: Emitted when a session is created. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionEventAgentSessionCreated - term: SubagentResource definition: A subagent created within a session. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SubagentResource - term: MultiAgentConfigResource definition: The resolved configuration for creating and coordinating subagents. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/MultiAgentConfigResource - term: EnvironmentParam definition: The execution environment and optional reusable template for a session. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/EnvironmentParam - term: EnvironmentResourceNone definition: The session talks to CCA without selecting or provisioning an execution environment. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/EnvironmentResourceNone - term: CreateAgentSessionParams definition: Parameters for creating a Managed Agents session. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/CreateAgentSessionParams - term: SessionEventAgentSessionEnvironmentReady definition: Emitted when a hosted session environment is ready to connect. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionEventAgentSessionEnvironmentReady - term: ReasoningEffortParam definition: The amount of reasoning effort the model should use. tags: - Enumeration source: openapi/openai-agents-api-openapi.yml#/components/schemas/ReasoningEffortParam - term: SessionInputParamAgentSessionInputMessage definition: Adds one or more user messages and starts a turn. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionInputParamAgentSessionInputMessage - term: SessionRequiredActionResourceFunctionCall definition: Run a function tool and submit its result. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionRequiredActionResourceFunctionCall - term: SessionInputParamAgentSessionInputCancel definition: Cancels the session's active turn. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionInputParamAgentSessionInputCancel - term: McpTransportResourceHttp definition: Connects to an MCP server over HTTP. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/McpTransportResourceHttp - term: SessionEventAgentSessionTurnCancelled definition: Emitted when a turn is cancelled. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionEventAgentSessionTurnCancelled - term: SendSubagentInputCallItemResource definition: A request to send input to another agent. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SendSubagentInputCallItemResource - term: SessionArtifactResource definition: An immutable file published by a completed hosted session turn. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionArtifactResource - term: SessionEventAgentSessionEnvironmentReset definition: Emitted after a hosted sandbox is replaced. Conversation history survives; changes to the previous sandbox's files and processes do not. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionEventAgentSessionEnvironmentReset - term: PersistedAgentToolConfigParamFunction definition: A function defined by the application. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/PersistedAgentToolConfigParamFunction - term: MessageItemResource definition: A user or assistant message recorded in a session. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/MessageItemResource - term: PersistedAgentToolConfigParamMcp definition: Tools provided by a remote MCP server without stored credentials. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/PersistedAgentToolConfigParamMcp - term: HostedPluginParamInline definition: Supplies a plugin ZIP directly in the session request. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/HostedPluginParamInline - term: PersistedMcpTransportConfigParamStdio definition: Starts an MCP server as a local process. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/PersistedMcpTransportConfigParamStdio - term: SessionEventAgentSessionTurnOutputTextDelta definition: Emitted when text is appended to an output text content part. tags: - Object source: openapi/openai-agents-api-openapi.yml#/components/schemas/SessionEventAgentSessionTurnOutputTextDelta