Crate codex_api 

Structs

AgentIdentityTelemetry

ApproximateLocation

AuthHeaderTelemetry

ClickOperation

CompactClient

CompactionInput

Canonical input payload for the compaction endpoint.

FinanceOperation

FindOperation

ImageData

ImageEditRequest

ImageGenerationRequest

ImageResponse

ImageUrl

ImagesClient

MemoriesClient

MemorySummarizeInput

Canonical input payload for the memory summarize endpoint.

MemorySummarizeOutput

ModelsClient

OpenOperation

Provider

HTTP endpoint configuration used to talk to a concrete API deployment.

RawMemory

RawMemoryMetadata

RealtimeAudioFrame

RealtimeCallClient

RealtimeCallResponse

Answer from creating a WebRTC Realtime call.

RealtimeSessionConfig

RealtimeWebsocketClient

RealtimeWebsocketConnection

RealtimeWebsocketEvents

RealtimeWebsocketWriter

Reasoning

ReqwestTransport

ResponseCreateWsRequest

ResponseStream

ResponsesApiRequest

ResponsesClient

ResponsesOptions

ResponsesWebsocketClient

Client for connecting to the Responses WebSocket endpoint for one provider.

ResponsesWebsocketClose

Close frame information captured by a handshake probe.

ResponsesWebsocketConnection

ResponsesWebsocketProbe

Result of a handshake-only Responses WebSocket probe.

RetryConfig

High-level retry configuration for a provider.

ScreenshotOperation

SearchClient

SearchCommands

SearchFilters

SearchImageSettings

SearchQuery

SearchRequest

SearchResponse

SearchSettings

SportsOperation

StreamOptions

TextControls

Controls the text field for the Responses API, combining verbosity and optional JSON schema output formatting.

TimeOperation

WeatherOperation

Enums

AllowedCaller

ApiError

AuthError

Error returned while applying authentication to an outbound request.

Compression

ExternalWebAccess

ExternalWebAccessMode

FinanceAssetType

ImageBackground

ImageQuality

LocationType

OpenAiVerbosity

RealtimeContextAppendChannel

Selects the semantic stream used for Frameless Bidi context appends.

RealtimeEvent

RealtimeEventParser

RealtimeOutputModality

RealtimeSessionMode

ReasoningContext

ReasoningSummaryDelivery

ResponseEvent

ResponsesWsRequest

SearchContextSize

SearchInput

SearchResponseLength

SportsFunction

SportsLeague

SportsToolName

TransportError

Constants

OPENAI_FILE_UPLOAD_LIMIT_BYTES

WS_REQUEST_HEADER_TRACEPARENT_CLIENT_METADATA_KEY

WS_REQUEST_HEADER_TRACESTATE_CLIENT_METADATA_KEY

Traits

AuthProvider

Applies authentication to API requests.

RequestTelemetry

API specific telemetry.

SseTelemetry

Generic telemetry.

WebsocketTelemetry

Telemetry for Responses WebSocket transport.

Functions

auth_header_telemetry

build_session_headers

create_text_param_for_request

is_azure_responses_provider

map_api_error

response_create_client_metadata

session_update_session_json

upload_openai_file

Type Aliases

AuthProviderFuture

SharedAuthProvider

Shared auth handle passed through API clients.