@oxy.so/contracts 4.2.0 → 4.4.0

package/dist/types/index.d.ts

@@ -74,18 +74,20 @@ export { embeddingVectorSchema, embeddingUsageSchema, embeddingSuccessSchema, em
 export type { EmbeddingVector, EmbeddingUsage, EmbeddingSuccess, EmbeddingFailure, EmbeddingResponse, } from './inference/embeddings';
 export { priceVersionStatusSchema, priceVersionSchema, priceSnapshotSchema, } from './inference/priceVersion';
 export type { PriceVersionStatus, PriceVersion, PriceSnapshot } from './inference/priceVersion';
-export { inferenceModalitySchema, reasoningEffortSchema, modelCapabilitiesSchema, modelLicenseSchema, modelProvenanceSchema, inferenceDataPolicySchema, availabilityScopeSchema, commercialPermissionSchema, modelDeprecationSchema, modelEvaluationResultSchema, modelSafetyMetadataSchema, modelPublisherSchema, catalogueModelSchema, modelRevisionSchema, inferenceProviderSchema, modelDeploymentSchema, routingProfileCandidateSchema, routingProfileSchema, cataloguePublisherSummarySchema, catalogueServingProviderSummarySchema, modelCatalogueEntrySchema, } from './inference/catalogue';
-export type { InferenceModality, ReasoningEffort, ModelCapabilities, ModelLicense, ModelProvenance, InferenceDataPolicy, AvailabilityScope, CommercialPermission, ModelDeprecation, ModelEvaluationResult, ModelSafetyMetadata, ModelPublisher, CatalogueModel, ModelRevision, InferenceProvider, ModelDeployment, RoutingProfileCandidate, RoutingProfile, CataloguePublisherSummary, CatalogueServingProviderSummary, ModelCatalogueEntry, } from './inference/catalogue';
+export { inferenceModalitySchema, reasoningEffortSchema, inferenceApiFormatSchema, realtimeSessionKindSchema, realtimeSessionTransportSchema, modelRealtimeCapabilitiesSchema, modelCapabilitiesSchema, modelLicenseSchema, modelProvenanceSchema, inferenceDataPolicySchema, availabilityScopeSchema, commercialPermissionSchema, modelDeprecationSchema, modelEvaluationResultSchema, modelSafetyMetadataSchema, modelPublisherSchema, catalogueModelSchema, modelRevisionSchema, inferenceProviderSchema, modelDeploymentSchema, routingProfileCandidateSchema, routingProfileSchema, cataloguePublisherSummarySchema, catalogueServingProviderSummarySchema, modelCatalogueEntrySchema, } from './inference/catalogue';
+export type { InferenceModality, ReasoningEffort, InferenceApiFormat, RealtimeSessionKind, RealtimeSessionTransport, ModelRealtimeCapabilities, ModelCapabilities, ModelLicense, ModelProvenance, InferenceDataPolicy, AvailabilityScope, CommercialPermission, ModelDeprecation, ModelEvaluationResult, ModelSafetyMetadata, ModelPublisher, CatalogueModel, ModelRevision, InferenceProvider, ModelDeployment, RoutingProfileCandidate, RoutingProfile, CataloguePublisherSummary, CatalogueServingProviderSummary, ModelCatalogueEntry, } from './inference/catalogue';
 export { routingTargetSchema, routingPolicyScopeSchema, routingFallbackPolicySchema, routingPolicySchema, routingPolicyReferenceSchema, authorizedRouteSchema, } from './inference/routingPolicy';
 export type { RoutingTarget, RoutingPolicyScope, RoutingFallbackPolicy, RoutingPolicy, RoutingPolicyReference, AuthorizedRoute, } from './inference/routingPolicy';
 export { aliaReleaseArtifactSchema, aliaReleaseSignatureSchema, aliaModelReleaseManifestSchema, } from './inference/aliaModelRelease';
 export type { AliaReleaseArtifact, AliaReleaseSignature, AliaModelReleaseManifest, } from './inference/aliaModelRelease';
 export { modelDistributionMethodSchema, modelSystemicRiskTierSchema, trainingComputeFlopsSchema, SYSTEMIC_RISK_COMPUTE_THRESHOLD_FLOPS, modelDownstreamDocumentationSchema, modelGpaiDocumentationSchema, modelLineDeclarationSchema, modelReleaseIngestionRequestSchema, modelReleaseIngestionResultSchema, modelDocumentationSchema, } from './inference/modelDocumentation';
 export type { ModelDistributionMethod, ModelSystemicRiskTier, ModelDownstreamDocumentation, ModelGpaiDocumentation, ModelLineDeclaration, ModelReleaseIngestionRequest, ModelReleaseIngestionResult, ModelDocumentation, } from './inference/modelDocumentation';
-export { inferenceContentSourceSchema, inferenceContentPartSchema, inferenceToolCallSchema, inferenceMessageRoleSchema, inferenceMessageSchema, inferenceInputSchema, samplingParametersSchema, inferenceReasoningSchema, toolDefinitionSchema, toolChoiceSchema, responseFormatSchema, clientRequestMetadataSchema, inferenceRequestSchema, inferenceSpeechParametersSchema, } from './inference/request';
-export type { InferenceContentSource, InferenceContentPart, InferenceToolCall, InferenceMessageRole, InferenceMessage, InferenceInput, SamplingParameters, InferenceReasoning, ToolDefinition, ToolChoice, ResponseFormat, ClientRequestMetadata, InferenceRequest, InferenceSpeechParameters, } from './inference/request';
+export { inferenceContentSourceSchema, inferenceContentPartSchema, inferenceToolCallSchema, inferenceMessageRoleSchema, inferenceMessageSchema, inferenceInputSchema, samplingParametersSchema, inferenceReasoningSchema, toolDefinitionSchema, toolChoiceSchema, responseFormatSchema, clientRequestMetadataSchema, inferenceRequestSchema, inferenceSpeechParametersSchema, inferenceAudioOutputParametersSchema, } from './inference/request';
+export type { InferenceContentSource, InferenceContentPart, InferenceToolCall, InferenceMessageRole, InferenceMessage, InferenceInput, SamplingParameters, InferenceReasoning, ToolDefinition, ToolChoice, ResponseFormat, ClientRequestMetadata, InferenceRequest, InferenceSpeechParameters, InferenceAudioOutputParameters, } from './inference/request';
 export { inferenceStreamStartEventSchema, inferenceStreamDeltaEventSchema, inferenceAudioMediaTypeSchema, MAX_INFERENCE_AUDIO_BYTES, inferenceStreamAudioEventSchema, inferenceStreamToolCallEventSchema, inferenceStreamUsageEventSchema, inferenceRouteSwitchDetailSchema, inferenceRouteSwitchReasonSchema, inferenceStreamRouteSwitchEventSchema, inferenceStreamErrorEventSchema, inferenceFinishReasonSchema, inferenceStreamDoneEventSchema, inferenceStreamEventSchema, } from './inference/streamEvents';
 export type { InferenceStreamStartEvent, InferenceStreamDeltaEvent, InferenceAudioMediaType, InferenceStreamAudioEvent, InferenceStreamToolCallEvent, InferenceStreamUsageEvent, InferenceRouteSwitchDetail, InferenceRouteSwitchReason, InferenceStreamRouteSwitchEvent, InferenceStreamErrorEvent, InferenceFinishReason, InferenceStreamDoneEvent, InferenceStreamEvent, } from './inference/streamEvents';
+export { MAX_REALTIME_AUDIO_FRAME_BASE64_LENGTH, MAX_REALTIME_SESSION_DURATION_MS, MAX_REALTIME_SESSION_AUDIO_BYTES, MAX_REALTIME_RESUME_WINDOW_MS, realtimeCommandIdSchema, realtimeItemIdSchema, realtimeResponseIdSchema, realtimeAudioFormatSchema, realtimeOutputModalitySchema, realtimeTurnDetectionSchema, realtimeInputTranscriptionSchema, realtimeTranslationSchema, realtimeSessionConfigSchema, realtimeSessionConfigUpdateSchema, realtimeSessionLimitsSchema, realtimeClientMetadataSchema, realtimeSessionRequestSchema, realtimeContentPartSchema, realtimeConversationItemSchema, realtimeResponseParametersSchema, realtimeSessionUpdateCommandSchema, realtimeItemCreateCommandSchema, realtimeItemDeleteCommandSchema, realtimeItemTruncateCommandSchema, realtimeInputAudioAppendCommandSchema, realtimeInputAudioCommitCommandSchema, realtimeInputAudioClearCommandSchema, realtimeResponseCreateCommandSchema, realtimeResponseCancelCommandSchema, realtimeSessionResumeCommandSchema, realtimeSessionCloseCommandSchema, realtimeClientCommandSchema, realtimeSessionCreatedEventSchema, realtimeSessionUpdatedEventSchema, realtimeSessionResumedEventSchema, realtimeCommandAcceptedEventSchema, realtimeItemAddedEventSchema, realtimeItemDoneEventSchema, realtimeItemDeletedEventSchema, realtimeItemTruncatedEventSchema, realtimeSpeechStartedEventSchema, realtimeSpeechStoppedEventSchema, realtimeInputAudioCommittedEventSchema, realtimeInputAudioClearedEventSchema, realtimeResponseCreatedEventSchema, realtimeOutputAudioDeltaEventSchema, realtimeOutputAudioDoneEventSchema, realtimeTranscriptSourceSchema, realtimeTranscriptDeltaEventSchema, realtimeTranscriptDoneEventSchema, realtimeTextDeltaEventSchema, realtimeToolCallEventSchema, realtimeResponseStatusSchema, realtimeResponseDoneEventSchema, realtimeErrorEventSchema, realtimeSessionCloseReasonSchema, realtimeSessionClosedEventSchema, realtimeServerEventSchema, } from './inference/realtime';
+export type { RealtimeAudioFormat, RealtimeOutputModality, RealtimeTurnDetection, RealtimeInputTranscription, RealtimeTranslation, RealtimeSessionConfig, RealtimeSessionConfigUpdate, RealtimeSessionLimits, RealtimeClientMetadata, RealtimeSessionRequest, RealtimeContentPart, RealtimeConversationItem, RealtimeResponseParameters, RealtimeClientCommand, RealtimeTranscriptSource, RealtimeResponseStatus, RealtimeSessionCloseReason, RealtimeServerEvent, } from './inference/realtime';
 export { usageReservationRequestSchema, usageReservationStatusSchema, usageReservationSchema, inferenceRequestOutcomeSchema, normalizedUsageReportSchema, usageReceiptSchema, usageRefundSubjectSchema, usageRefundReasonSchema, usageRefundSchema, } from './inference/usage';
 export type { UsageReservationRequest, UsageReservationStatus, UsageReservation, InferenceRequestOutcome, NormalizedUsageReport, UsageReceipt, UsageRefundSubject, UsageRefundReason, UsageRefund, } from './inference/usage';
 export { providerConnectionScopeSchema, kaanaCredentialHandleSchema, kaanaCredentialOperationIdSchema, kaanaCredentialOperationActionSchema, kaanaCredentialIdentitySchema, kaanaCredentialCreateMutationSchema, kaanaCredentialRotateMutationSchema, kaanaCredentialRevokeMutationSchema, kaanaCredentialMutationSchema, kaanaCredentialCreateOutcomeRequestSchema, kaanaCredentialRotateOutcomeRequestSchema, kaanaCredentialRevokeOutcomeRequestSchema, kaanaCredentialOutcomeRequestSchema, kaanaCredentialAppliedOutcomeSchema, kaanaCredentialConflictOutcomeSchema, kaanaCredentialOutcomeSchema, kaanaCredentialValidationTaskSchema, kaanaCredentialValidationOutcomeStateSchema, kaanaCredentialValidationFailureCodeSchema, kaanaCredentialValidationOutcomeSchema, providerCredentialValidationOperationSchema, providerCredentialValidationDeploymentSchema, providerCredentialCustodyStateSchema, providerConnectionValidationSchema, providerConnectionStatusSchema, providerConnectionSchema, } from './inference/providerConnection';
@@ -105,3 +107,4 @@ export * from './linkedAccounts';
 export * from './federationInstanceFetch';
 export * from './notifications';
 export * from './email/messages';
+export * from './stickers';

package/dist/types/inference/catalogue.d.ts

@@ -38,12 +38,54 @@ export declare const inferenceModalitySchema: z.ZodEnum<["text", "image", "audio
  * effort the resolved model does not advertise rather than dropping it.
  */
 export declare const reasoningEffortSchema: z.ZodEnum<["low", "medium", "high"]>;
+/**
+ * The public dialects a request can arrive in — `client.apiFormat` on the
+ * envelope, and the list a deployment declares it can execute.
+ *
+ * Named (contract set 3.2.0) rather than inline on the client metadata so the
+ * two uses cannot drift: a capability naming a dialect the envelope cannot
+ * carry, or the reverse, would authorize a request no route can serve.
+ */
+export declare const inferenceApiFormatSchema: z.ZodEnum<["responses", "chat_completions", "embeddings", "images_generations", "audio_transcriptions", "audio_speech", "rerank", "batches"]>;
+/**
+ * What a realtime session is FOR. The three are different upstream products
+ * with different event families and different metering, not options of one:
+ *
+ *  - `conversation` — a speech-to-speech (or text) model holding a dialogue,
+ *    with responses, tool calls and interruption.
+ *  - `transcription` — live speech-to-text; the model never responds, it only
+ *    transcribes committed input audio.
+ *  - `translation` — live speech-to-speech translation into one target language.
+ */
+export declare const realtimeSessionKindSchema: z.ZodEnum<["conversation", "transcription", "translation"]>;
+/**
+ * How a realtime session is carried. One member today: a WebSocket, whose every
+ * frame is one JSON message (see `realtime.ts`). WebRTC and SIP are separate
+ * transports with separate media handling, and are added as members only when a
+ * deployment can actually execute them.
+ */
+export declare const realtimeSessionTransportSchema: z.ZodEnum<["websocket"]>;
+/**
+ * What a deployment can execute as a realtime session. Present only on a model
+ * that holds sessions; absent means it holds none, which is the state of every
+ * catalogue written before contract set 3.2.0.
+ */
+export declare const modelRealtimeCapabilitiesSchema: z.ZodObject<{
+    transports: z.ZodArray<z.ZodEnum<["websocket"]>, "many">;
+    sessionKinds: z.ZodArray<z.ZodEnum<["conversation", "transcription", "translation"]>, "many">;
+}, "strict", z.ZodTypeAny, {
+    transports: "websocket"[];
+    sessionKinds: ("conversation" | "transcription" | "translation")[];
+}, {
+    transports: "websocket"[];
+    sessionKinds: ("conversation" | "transcription" | "translation")[];
+}>;
 /**
  * What a model can do, in the terms a caller has to decide against before
  * sending a request: can it call tools, does it accept images, will it honour a
  * JSON schema, how much context does it take, how much can it emit.
  */
-export declare const modelCapabilitiesSchema: z.ZodObject<{
+export declare const modelCapabilitiesSchema: z.ZodEffects<z.ZodObject<{
     inputModalities: z.ZodArray<z.ZodEnum<["text", "image", "audio", "video", "embedding"]>, "many">;
     outputModalities: z.ZodArray<z.ZodEnum<["text", "image", "audio", "video", "embedding"]>, "many">;
     tools: z.ZodBoolean;
@@ -62,6 +104,31 @@ export declare const modelCapabilitiesSchema: z.ZodObject<{
     promptCaching: z.ZodBoolean;
     maxContextTokens: z.ZodNumber;
     maxOutputTokens: z.ZodNumber;
+    /**
+     * The request dialects a route to this model can EXECUTE. Modalities say
+     * what a model consumes and produces; they do not say which request shape a
+     * route can carry, and catalogue presence is not that evidence either — a
+     * speech-to-speech model is `audio` in and out and still cannot answer a
+     * `/v1/audio/transcriptions` upload. Oxy authorizes a request only when its
+     * `client.apiFormat` is listed here.
+     *
+     * Added in contract set 3.2.0. ABSENT means undeclared — a catalogue from an
+     * older producer — never "every format": a consumer then applies the rules it
+     * applied before this field existed, and authorizes no format that needs a
+     * declaration (audio output on `chat_completions`, a realtime session).
+     */
+    apiFormats: z.ZodOptional<z.ZodArray<z.ZodEnum<["responses", "chat_completions", "embeddings", "images_generations", "audio_transcriptions", "audio_speech", "rerank", "batches"]>, "many">>;
+    /** Realtime sessions this model holds; absent means none. Contract set 3.2.0. */
+    realtime: z.ZodOptional<z.ZodObject<{
+        transports: z.ZodArray<z.ZodEnum<["websocket"]>, "many">;
+        sessionKinds: z.ZodArray<z.ZodEnum<["conversation", "transcription", "translation"]>, "many">;
+    }, "strict", z.ZodTypeAny, {
+        transports: "websocket"[];
+        sessionKinds: ("conversation" | "transcription" | "translation")[];
+    }, {
+        transports: "websocket"[];
+        sessionKinds: ("conversation" | "transcription" | "translation")[];
+    }>>;
 }, "strict", z.ZodTypeAny, {
     tools: boolean;
     inputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
@@ -75,6 +142,47 @@ export declare const modelCapabilitiesSchema: z.ZodObject<{
     promptCaching: boolean;
     maxContextTokens: number;
     maxOutputTokens: number;
+    apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+    realtime?: {
+        transports: "websocket"[];
+        sessionKinds: ("conversation" | "transcription" | "translation")[];
+    } | undefined;
+}, {
+    tools: boolean;
+    inputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
+    outputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
+    parallelToolCalls: boolean;
+    structuredOutput: boolean;
+    jsonMode: boolean;
+    reasoning: boolean;
+    streaming: boolean;
+    promptCaching: boolean;
+    maxContextTokens: number;
+    maxOutputTokens: number;
+    reasoningEfforts?: ("low" | "medium" | "high")[] | undefined;
+    apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+    realtime?: {
+        transports: "websocket"[];
+        sessionKinds: ("conversation" | "transcription" | "translation")[];
+    } | undefined;
+}>, {
+    tools: boolean;
+    inputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
+    outputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
+    parallelToolCalls: boolean;
+    structuredOutput: boolean;
+    jsonMode: boolean;
+    reasoning: boolean;
+    reasoningEfforts: ("low" | "medium" | "high")[];
+    streaming: boolean;
+    promptCaching: boolean;
+    maxContextTokens: number;
+    maxOutputTokens: number;
+    apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+    realtime?: {
+        transports: "websocket"[];
+        sessionKinds: ("conversation" | "transcription" | "translation")[];
+    } | undefined;
 }, {
     tools: boolean;
     inputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
@@ -88,6 +196,11 @@ export declare const modelCapabilitiesSchema: z.ZodObject<{
     maxContextTokens: number;
     maxOutputTokens: number;
     reasoningEfforts?: ("low" | "medium" | "high")[] | undefined;
+    apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+    realtime?: {
+        transports: "websocket"[];
+        sessionKinds: ("conversation" | "transcription" | "translation")[];
+    } | undefined;
 }>;
 /**
  * License terms, including the two questions that decide whether Oxy may serve
@@ -299,7 +412,7 @@ export declare const catalogueModelSchema: z.ZodEffects<z.ZodObject<{
     slug: z.ZodString;
     displayName: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
-    capabilities: z.ZodObject<{
+    capabilities: z.ZodEffects<z.ZodObject<{
         inputModalities: z.ZodArray<z.ZodEnum<["text", "image", "audio", "video", "embedding"]>, "many">;
         outputModalities: z.ZodArray<z.ZodEnum<["text", "image", "audio", "video", "embedding"]>, "many">;
         tools: z.ZodBoolean;
@@ -318,6 +431,31 @@ export declare const catalogueModelSchema: z.ZodEffects<z.ZodObject<{
         promptCaching: z.ZodBoolean;
         maxContextTokens: z.ZodNumber;
         maxOutputTokens: z.ZodNumber;
+        /**
+         * The request dialects a route to this model can EXECUTE. Modalities say
+         * what a model consumes and produces; they do not say which request shape a
+         * route can carry, and catalogue presence is not that evidence either — a
+         * speech-to-speech model is `audio` in and out and still cannot answer a
+         * `/v1/audio/transcriptions` upload. Oxy authorizes a request only when its
+         * `client.apiFormat` is listed here.
+         *
+         * Added in contract set 3.2.0. ABSENT means undeclared — a catalogue from an
+         * older producer — never "every format": a consumer then applies the rules it
+         * applied before this field existed, and authorizes no format that needs a
+         * declaration (audio output on `chat_completions`, a realtime session).
+         */
+        apiFormats: z.ZodOptional<z.ZodArray<z.ZodEnum<["responses", "chat_completions", "embeddings", "images_generations", "audio_transcriptions", "audio_speech", "rerank", "batches"]>, "many">>;
+        /** Realtime sessions this model holds; absent means none. Contract set 3.2.0. */
+        realtime: z.ZodOptional<z.ZodObject<{
+            transports: z.ZodArray<z.ZodEnum<["websocket"]>, "many">;
+            sessionKinds: z.ZodArray<z.ZodEnum<["conversation", "transcription", "translation"]>, "many">;
+        }, "strict", z.ZodTypeAny, {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        }, {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        }>>;
     }, "strict", z.ZodTypeAny, {
         tools: boolean;
         inputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
@@ -331,6 +469,47 @@ export declare const catalogueModelSchema: z.ZodEffects<z.ZodObject<{
         promptCaching: boolean;
         maxContextTokens: number;
         maxOutputTokens: number;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
+    }, {
+        tools: boolean;
+        inputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
+        outputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
+        parallelToolCalls: boolean;
+        structuredOutput: boolean;
+        jsonMode: boolean;
+        reasoning: boolean;
+        streaming: boolean;
+        promptCaching: boolean;
+        maxContextTokens: number;
+        maxOutputTokens: number;
+        reasoningEfforts?: ("low" | "medium" | "high")[] | undefined;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
+    }>, {
+        tools: boolean;
+        inputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
+        outputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
+        parallelToolCalls: boolean;
+        structuredOutput: boolean;
+        jsonMode: boolean;
+        reasoning: boolean;
+        reasoningEfforts: ("low" | "medium" | "high")[];
+        streaming: boolean;
+        promptCaching: boolean;
+        maxContextTokens: number;
+        maxOutputTokens: number;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
     }, {
         tools: boolean;
         inputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
@@ -344,6 +523,11 @@ export declare const catalogueModelSchema: z.ZodEffects<z.ZodObject<{
         maxContextTokens: number;
         maxOutputTokens: number;
         reasoningEfforts?: ("low" | "medium" | "high")[] | undefined;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
     }>;
     license: z.ZodObject<{
         /** SPDX identifier where one exists, otherwise the publisher's own name. */
@@ -427,6 +611,11 @@ export declare const catalogueModelSchema: z.ZodEffects<z.ZodObject<{
         promptCaching: boolean;
         maxContextTokens: number;
         maxOutputTokens: number;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
     };
     schemaVersion: 1;
     slug: string;
@@ -470,6 +659,11 @@ export declare const catalogueModelSchema: z.ZodEffects<z.ZodObject<{
         maxContextTokens: number;
         maxOutputTokens: number;
         reasoningEfforts?: ("low" | "medium" | "high")[] | undefined;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
     };
     schemaVersion: 1;
     slug: string;
@@ -513,6 +707,11 @@ export declare const catalogueModelSchema: z.ZodEffects<z.ZodObject<{
         promptCaching: boolean;
         maxContextTokens: number;
         maxOutputTokens: number;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
     };
     schemaVersion: 1;
     slug: string;
@@ -556,6 +755,11 @@ export declare const catalogueModelSchema: z.ZodEffects<z.ZodObject<{
         maxContextTokens: number;
         maxOutputTokens: number;
         reasoningEfforts?: ("low" | "medium" | "high")[] | undefined;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
     };
     schemaVersion: 1;
     slug: string;
@@ -1150,7 +1354,7 @@ export declare const modelCatalogueEntrySchema: z.ZodObject<{
     currentRevision: z.ZodString;
     /** Revisions a customer may pin today, newest first. */
     availableRevisions: z.ZodArray<z.ZodString, "many">;
-    capabilities: z.ZodObject<{
+    capabilities: z.ZodEffects<z.ZodObject<{
         inputModalities: z.ZodArray<z.ZodEnum<["text", "image", "audio", "video", "embedding"]>, "many">;
         outputModalities: z.ZodArray<z.ZodEnum<["text", "image", "audio", "video", "embedding"]>, "many">;
         tools: z.ZodBoolean;
@@ -1169,6 +1373,31 @@ export declare const modelCatalogueEntrySchema: z.ZodObject<{
         promptCaching: z.ZodBoolean;
         maxContextTokens: z.ZodNumber;
         maxOutputTokens: z.ZodNumber;
+        /**
+         * The request dialects a route to this model can EXECUTE. Modalities say
+         * what a model consumes and produces; they do not say which request shape a
+         * route can carry, and catalogue presence is not that evidence either — a
+         * speech-to-speech model is `audio` in and out and still cannot answer a
+         * `/v1/audio/transcriptions` upload. Oxy authorizes a request only when its
+         * `client.apiFormat` is listed here.
+         *
+         * Added in contract set 3.2.0. ABSENT means undeclared — a catalogue from an
+         * older producer — never "every format": a consumer then applies the rules it
+         * applied before this field existed, and authorizes no format that needs a
+         * declaration (audio output on `chat_completions`, a realtime session).
+         */
+        apiFormats: z.ZodOptional<z.ZodArray<z.ZodEnum<["responses", "chat_completions", "embeddings", "images_generations", "audio_transcriptions", "audio_speech", "rerank", "batches"]>, "many">>;
+        /** Realtime sessions this model holds; absent means none. Contract set 3.2.0. */
+        realtime: z.ZodOptional<z.ZodObject<{
+            transports: z.ZodArray<z.ZodEnum<["websocket"]>, "many">;
+            sessionKinds: z.ZodArray<z.ZodEnum<["conversation", "transcription", "translation"]>, "many">;
+        }, "strict", z.ZodTypeAny, {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        }, {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        }>>;
     }, "strict", z.ZodTypeAny, {
         tools: boolean;
         inputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
@@ -1182,6 +1411,47 @@ export declare const modelCatalogueEntrySchema: z.ZodObject<{
         promptCaching: boolean;
         maxContextTokens: number;
         maxOutputTokens: number;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
+    }, {
+        tools: boolean;
+        inputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
+        outputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
+        parallelToolCalls: boolean;
+        structuredOutput: boolean;
+        jsonMode: boolean;
+        reasoning: boolean;
+        streaming: boolean;
+        promptCaching: boolean;
+        maxContextTokens: number;
+        maxOutputTokens: number;
+        reasoningEfforts?: ("low" | "medium" | "high")[] | undefined;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
+    }>, {
+        tools: boolean;
+        inputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
+        outputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
+        parallelToolCalls: boolean;
+        structuredOutput: boolean;
+        jsonMode: boolean;
+        reasoning: boolean;
+        reasoningEfforts: ("low" | "medium" | "high")[];
+        streaming: boolean;
+        promptCaching: boolean;
+        maxContextTokens: number;
+        maxOutputTokens: number;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
     }, {
         tools: boolean;
         inputModalities: ("image" | "embedding" | "text" | "audio" | "video")[];
@@ -1195,6 +1465,11 @@ export declare const modelCatalogueEntrySchema: z.ZodObject<{
         maxContextTokens: number;
         maxOutputTokens: number;
         reasoningEfforts?: ("low" | "medium" | "high")[] | undefined;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
     }>;
     license: z.ZodObject<{
         /** SPDX identifier where one exists, otherwise the publisher's own name. */
@@ -1352,19 +1627,19 @@ export declare const modelCatalogueEntrySchema: z.ZodObject<{
         priceVersionId: z.ZodString;
         currency: z.ZodString;
         unitPrices: z.ZodArray<z.ZodObject<{
-            unit: z.ZodEnum<["input_tokens", "cached_input_tokens", "output_tokens", "reasoning_tokens", "requests", "images", "audio_input_milliseconds", "audio_output_milliseconds", "video_milliseconds", "characters", "embeddings"]>;
+            unit: z.ZodEnum<["input_tokens", "cached_input_tokens", "output_tokens", "reasoning_tokens", "requests", "images", "audio_input_milliseconds", "audio_output_milliseconds", "video_milliseconds", "characters", "embeddings", "audio_input_tokens", "cached_audio_input_tokens", "audio_output_tokens"]>;
             amount: z.ZodBranded<z.ZodString, "ExactDecimal">;
             per: z.ZodNumber;
             currency: z.ZodString;
         }, "strict", z.ZodTypeAny, {
             currency: string;
             amount: string & z.BRAND<"ExactDecimal">;
-            unit: "input_tokens" | "cached_input_tokens" | "output_tokens" | "reasoning_tokens" | "requests" | "images" | "audio_input_milliseconds" | "audio_output_milliseconds" | "video_milliseconds" | "characters" | "embeddings";
+            unit: "input_tokens" | "cached_input_tokens" | "output_tokens" | "reasoning_tokens" | "requests" | "images" | "audio_input_milliseconds" | "audio_output_milliseconds" | "video_milliseconds" | "characters" | "embeddings" | "audio_input_tokens" | "cached_audio_input_tokens" | "audio_output_tokens";
             per: number;
         }, {
             currency: string;
             amount: string;
-            unit: "input_tokens" | "cached_input_tokens" | "output_tokens" | "reasoning_tokens" | "requests" | "images" | "audio_input_milliseconds" | "audio_output_milliseconds" | "video_milliseconds" | "characters" | "embeddings";
+            unit: "input_tokens" | "cached_input_tokens" | "output_tokens" | "reasoning_tokens" | "requests" | "images" | "audio_input_milliseconds" | "audio_output_milliseconds" | "video_milliseconds" | "characters" | "embeddings" | "audio_input_tokens" | "cached_audio_input_tokens" | "audio_output_tokens";
             per: number;
         }>, "many">;
     }, "strict", z.ZodTypeAny, {
@@ -1373,7 +1648,7 @@ export declare const modelCatalogueEntrySchema: z.ZodObject<{
         unitPrices: {
             currency: string;
             amount: string & z.BRAND<"ExactDecimal">;
-            unit: "input_tokens" | "cached_input_tokens" | "output_tokens" | "reasoning_tokens" | "requests" | "images" | "audio_input_milliseconds" | "audio_output_milliseconds" | "video_milliseconds" | "characters" | "embeddings";
+            unit: "input_tokens" | "cached_input_tokens" | "output_tokens" | "reasoning_tokens" | "requests" | "images" | "audio_input_milliseconds" | "audio_output_milliseconds" | "video_milliseconds" | "characters" | "embeddings" | "audio_input_tokens" | "cached_audio_input_tokens" | "audio_output_tokens";
             per: number;
         }[];
     }, {
@@ -1382,7 +1657,7 @@ export declare const modelCatalogueEntrySchema: z.ZodObject<{
         unitPrices: {
             currency: string;
             amount: string;
-            unit: "input_tokens" | "cached_input_tokens" | "output_tokens" | "reasoning_tokens" | "requests" | "images" | "audio_input_milliseconds" | "audio_output_milliseconds" | "video_milliseconds" | "characters" | "embeddings";
+            unit: "input_tokens" | "cached_input_tokens" | "output_tokens" | "reasoning_tokens" | "requests" | "images" | "audio_input_milliseconds" | "audio_output_milliseconds" | "video_milliseconds" | "characters" | "embeddings" | "audio_input_tokens" | "cached_audio_input_tokens" | "audio_output_tokens";
             per: number;
         }[];
     }>>;
@@ -1469,6 +1744,11 @@ export declare const modelCatalogueEntrySchema: z.ZodObject<{
         promptCaching: boolean;
         maxContextTokens: number;
         maxOutputTokens: number;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
     };
     schemaVersion: 3;
     modelId: string;
@@ -1546,7 +1826,7 @@ export declare const modelCatalogueEntrySchema: z.ZodObject<{
         unitPrices: {
             currency: string;
             amount: string & z.BRAND<"ExactDecimal">;
-            unit: "input_tokens" | "cached_input_tokens" | "output_tokens" | "reasoning_tokens" | "requests" | "images" | "audio_input_milliseconds" | "audio_output_milliseconds" | "video_milliseconds" | "characters" | "embeddings";
+            unit: "input_tokens" | "cached_input_tokens" | "output_tokens" | "reasoning_tokens" | "requests" | "images" | "audio_input_milliseconds" | "audio_output_milliseconds" | "video_milliseconds" | "characters" | "embeddings" | "audio_input_tokens" | "cached_audio_input_tokens" | "audio_output_tokens";
             per: number;
         }[];
     } | undefined;
@@ -1565,6 +1845,11 @@ export declare const modelCatalogueEntrySchema: z.ZodObject<{
         maxContextTokens: number;
         maxOutputTokens: number;
         reasoningEfforts?: ("low" | "medium" | "high")[] | undefined;
+        apiFormats?: ("embeddings" | "responses" | "chat_completions" | "images_generations" | "audio_transcriptions" | "audio_speech" | "rerank" | "batches")[] | undefined;
+        realtime?: {
+            transports: "websocket"[];
+            sessionKinds: ("conversation" | "transcription" | "translation")[];
+        } | undefined;
     };
     schemaVersion: 3;
     modelId: string;
@@ -1642,13 +1927,17 @@ export declare const modelCatalogueEntrySchema: z.ZodObject<{
         unitPrices: {
             currency: string;
             amount: string;
-            unit: "input_tokens" | "cached_input_tokens" | "output_tokens" | "reasoning_tokens" | "requests" | "images" | "audio_input_milliseconds" | "audio_output_milliseconds" | "video_milliseconds" | "characters" | "embeddings";
+            unit: "input_tokens" | "cached_input_tokens" | "output_tokens" | "reasoning_tokens" | "requests" | "images" | "audio_input_milliseconds" | "audio_output_milliseconds" | "video_milliseconds" | "characters" | "embeddings" | "audio_input_tokens" | "cached_audio_input_tokens" | "audio_output_tokens";
             per: number;
         }[];
     } | undefined;
 }>;
 export type InferenceModality = z.infer<typeof inferenceModalitySchema>;
 export type ReasoningEffort = z.infer<typeof reasoningEffortSchema>;
+export type InferenceApiFormat = z.infer<typeof inferenceApiFormatSchema>;
+export type RealtimeSessionKind = z.infer<typeof realtimeSessionKindSchema>;
+export type RealtimeSessionTransport = z.infer<typeof realtimeSessionTransportSchema>;
+export type ModelRealtimeCapabilities = z.infer<typeof modelRealtimeCapabilitiesSchema>;
 export type ModelCapabilities = z.infer<typeof modelCapabilitiesSchema>;
 export type ModelLicense = z.infer<typeof modelLicenseSchema>;
 export type ModelProvenance = z.infer<typeof modelProvenanceSchema>;

package/dist/types/inference/entitlement.d.ts

@@ -114,7 +114,7 @@ export declare const productPlanSchema: z.ZodObject<{
         remaining?: number | undefined;
     }>, "many">;
 }, "strict", z.ZodTypeAny, {
-    status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+    status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
     name: string;
     id: string;
     live: boolean;
@@ -127,7 +127,7 @@ export declare const productPlanSchema: z.ZodObject<{
         remaining?: number | undefined;
     }[];
 }, {
-    status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+    status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
     name: string;
     id: string;
     live: boolean;
@@ -326,7 +326,7 @@ export declare const productEntitlementSchema: z.ZodObject<{
             remaining?: number | undefined;
         }>, "many">;
     }, "strict", z.ZodTypeAny, {
-        status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+        status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
         name: string;
         id: string;
         live: boolean;
@@ -339,7 +339,7 @@ export declare const productEntitlementSchema: z.ZodObject<{
             remaining?: number | undefined;
         }[];
     }, {
-        status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+        status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
         name: string;
         id: string;
         live: boolean;
@@ -444,7 +444,7 @@ export declare const productEntitlementSchema: z.ZodObject<{
         label: string;
     } | null;
     plan: {
-        status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+        status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
         name: string;
         id: string;
         live: boolean;
@@ -485,7 +485,7 @@ export declare const productEntitlementSchema: z.ZodObject<{
         label: string;
     } | null;
     plan: {
-        status: "active" | "canceled" | "incomplete" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
+        status: "active" | "incomplete" | "canceled" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid";
         name: string;
         id: string;
         live: boolean;

package/dist/types/inference/inbox.d.ts

@@ -5,13 +5,13 @@ export declare const inboxComposeRequestSchema: z.ZodDiscriminatedUnion<"operati
     tone: z.ZodEnum<["professional", "casual", "friendly", "formal"]>;
     stream: z.ZodOptional<z.ZodBoolean>;
 }, "strict", z.ZodTypeAny, {
-    operation: "draft";
     prompt: string;
+    operation: "draft";
     tone: "professional" | "casual" | "friendly" | "formal";
     stream?: boolean | undefined;
 }, {
-    operation: "draft";
     prompt: string;
+    operation: "draft";
     tone: "professional" | "casual" | "friendly" | "formal";
     stream?: boolean | undefined;
 }>, z.ZodObject<{