Realtime translation server events

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

error

Returned when an error occurs, which could be a client problem or a server problem. Most errors are recoverable and the session will stay open, we recommend to implementors to monitor and log error messages by default.

Schema

Schema name: RealtimeServerEventError

{
  "(resource) realtime > (model) realtime_error_event > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/RealtimeServerEventError",
    "ident": "RealtimeErrorEvent",
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "error"
        },
        {
          "ident": "event_id"
        },
        {
          "ident": "type"
        }
      ]
    },
    "docstring": "Returned when an error occurs, which could be a client problem or a server\nproblem. Most errors are recoverable and the session will stay open, we\nrecommend to implementors to monitor and log error messages by default.\n",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_error_event > (schema) > (property) error",
      "(resource) realtime > (model) realtime_error_event > (schema) > (property) event_id",
      "(resource) realtime > (model) realtime_error_event > (schema) > (property) type"
    ]
  },
  "(resource) realtime > (model) realtime_error_event > (schema) > (property) error": {
    "kind": "HttpDeclProperty",
    "docstring": "Details of the error.",
    "key": "error",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeReference",
      "ident": "RealtimeError",
      "$ref": "(resource) realtime > (model) realtime_error > (schema)"
    },
    "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error",
    "deprecated": false,
    "schemaType": "object",
    "modelImplicit": false,
    "modelPath": "(resource) realtime > (model) realtime_error",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_error > (schema) > (property) message",
      "(resource) realtime > (model) realtime_error > (schema) > (property) type",
      "(resource) realtime > (model) realtime_error > (schema) > (property) code",
      "(resource) realtime > (model) realtime_error > (schema) > (property) event_id",
      "(resource) realtime > (model) realtime_error > (schema) > (property) param"
    ]
  },
  "(resource) realtime > (model) realtime_error_event > (schema) > (property) event_id": {
    "kind": "HttpDeclProperty",
    "docstring": "The unique ID of the server event.",
    "key": "event_id",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeServerEventError/properties/event_id",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_error_event > (schema) > (property) type": {
    "kind": "HttpDeclProperty",
    "docstring": "The event type, must be `error`.",
    "key": "type",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeUnion",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "error"
        }
      ],
      "oasRef": "#/components/schemas/RealtimeServerEventError/properties/type"
    },
    "oasRef": "#/components/schemas/RealtimeServerEventError/properties/type",
    "deprecated": false,
    "schemaType": "enum",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) realtime_error_event > (schema) > (property) type > (member) 0"
    ]
  },
  "(resource) realtime > (model) realtime_error > (schema) > (property) message": {
    "kind": "HttpDeclProperty",
    "docstring": "A human-readable error message.",
    "key": "message",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/message",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_error > (schema) > (property) type": {
    "kind": "HttpDeclProperty",
    "docstring": "The type of error (e.g., \"invalid_request_error\", \"server_error\").\n",
    "key": "type",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/type",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_error > (schema) > (property) code": {
    "kind": "HttpDeclProperty",
    "docstring": "Error code, if any.",
    "key": "code",
    "optional": true,
    "nullable": true,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/code",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_error > (schema) > (property) event_id": {
    "kind": "HttpDeclProperty",
    "docstring": "The event_id of the client event that caused the error, if applicable.\n",
    "key": "event_id",
    "optional": true,
    "nullable": true,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/event_id",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_error > (schema) > (property) param": {
    "kind": "HttpDeclProperty",
    "docstring": "Parameter related to the error, if any.",
    "key": "param",
    "optional": true,
    "nullable": true,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/param",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_error > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error",
    "ident": "RealtimeError",
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "message"
        },
        {
          "ident": "type"
        },
        {
          "ident": "code"
        },
        {
          "ident": "event_id"
        },
        {
          "ident": "param"
        }
      ]
    },
    "docstring": "Details of the error.",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_error > (schema) > (property) message",
      "(resource) realtime > (model) realtime_error > (schema) > (property) type",
      "(resource) realtime > (model) realtime_error > (schema) > (property) code",
      "(resource) realtime > (model) realtime_error > (schema) > (property) event_id",
      "(resource) realtime > (model) realtime_error > (schema) > (property) param"
    ]
  },
  "(resource) realtime > (model) realtime_error_event > (schema) > (property) type > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "error"
    }
  }
}

Example

{
    "event_id": "event_890",
    "type": "error",
    "error": {
        "type": "invalid_request_error",
        "code": "invalid_event",
        "message": "The 'type' field is missing.",
        "param": null,
        "event_id": "event_567"
    }
}

session.created

Returned when a translation session is created. Emitted automatically when a new connection is established as the first server event. This event contains the default translation session configuration.

Schema

Schema name: RealtimeTranslationServerEventSessionCreated

{
  "(resource) realtime > (model) realtime_translation_session_created_event > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated",
    "ident": "RealtimeTranslationSessionCreatedEvent",
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "event_id"
        },
        {
          "ident": "session"
        },
        {
          "ident": "type"
        }
      ]
    },
    "docstring": "Returned when a translation session is created. Emitted automatically when a\nnew connection is established as the first server event. This event contains\nthe default translation session configuration.\n",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) event_id",
      "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) session",
      "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) type"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) event_id": {
    "kind": "HttpDeclProperty",
    "docstring": "The unique ID of the server event.",
    "key": "event_id",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/event_id",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) session": {
    "kind": "HttpDeclProperty",
    "title": "Realtime translation session",
    "docstring": "The translation session configuration.",
    "key": "session",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeReference",
      "ident": "RealtimeTranslationSession",
      "$ref": "(resource) realtime > (model) realtime_translation_session > (schema)"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/session",
    "deprecated": false,
    "schemaType": "object",
    "modelImplicit": false,
    "modelPath": "(resource) realtime > (model) realtime_translation_session",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) type": {
    "kind": "HttpDeclProperty",
    "docstring": "The event type, must be `session.created`.",
    "key": "type",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeUnion",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "session.created"
        }
      ],
      "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/type"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/type",
    "deprecated": false,
    "schemaType": "enum",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) type > (member) 0"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id": {
    "kind": "HttpDeclProperty",
    "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n",
    "key": "id",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/id",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio": {
    "kind": "HttpDeclProperty",
    "docstring": "Configuration for translation input and output audio.\n",
    "key": "audio",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "input"
        },
        {
          "ident": "output"
        }
      ]
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio",
    "deprecated": false,
    "schemaType": "object",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at": {
    "kind": "HttpDeclProperty",
    "docstring": "Expiration timestamp for the session, in seconds since epoch.",
    "key": "expires_at",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeNumber"
    },
    "constraints": {
      "format": "unixtime"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/expires_at",
    "deprecated": false,
    "schemaType": "integer",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model": {
    "kind": "HttpDeclProperty",
    "docstring": "The Realtime translation model used for this session. This field is set at\nsession creation and cannot be changed with `session.update`.\n",
    "key": "model",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/model",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type": {
    "kind": "HttpDeclProperty",
    "docstring": "The session type. Always `translation` for Realtime translation sessions.\n",
    "key": "type",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeUnion",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "translation"
        }
      ],
      "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type",
    "deprecated": false,
    "schemaType": "enum",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type > (member) 0"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/RealtimeTranslationSession",
    "ident": "RealtimeTranslationSession",
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "id"
        },
        {
          "ident": "audio"
        },
        {
          "ident": "expires_at"
        },
        {
          "ident": "model"
        },
        {
          "ident": "type"
        }
      ]
    },
    "docstring": "A Realtime translation session. Translation sessions continuously translate input\naudio into the configured output language.\n",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) type > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "session.created"
    }
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input": {
    "kind": "HttpDeclProperty",
    "key": "input",
    "optional": true,
    "nullable": false,
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "noise_reduction"
        },
        {
          "ident": "transcription"
        }
      ]
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input",
    "deprecated": false,
    "schemaType": "object",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output": {
    "kind": "HttpDeclProperty",
    "key": "output",
    "optional": true,
    "nullable": false,
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "language"
        }
      ]
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output",
    "deprecated": false,
    "schemaType": "object",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output > (property) language"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "translation"
    }
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction": {
    "kind": "HttpDeclProperty",
    "docstring": "Optional input noise reduction.\n",
    "key": "noise_reduction",
    "optional": true,
    "nullable": true,
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "type"
        }
      ]
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction",
    "deprecated": false,
    "schemaType": "object",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription": {
    "kind": "HttpDeclProperty",
    "docstring": "Optional source-language transcription. When configured, the server emits\n`session.input_transcript.delta` events. Translation itself still runs from\nthe input audio stream.\n",
    "key": "transcription",
    "optional": true,
    "nullable": true,
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "model"
        }
      ]
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription",
    "deprecated": false,
    "schemaType": "object",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription > (property) model"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output > (property) language": {
    "kind": "HttpDeclProperty",
    "docstring": "Target language for translated output audio and transcript deltas.\n",
    "key": "language",
    "optional": true,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output/properties/language",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": {
    "kind": "HttpDeclProperty",
    "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",
    "key": "type",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeReference",
      "ident": "NoiseReductionType",
      "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction/anyOf/0/properties/type",
    "deprecated": false,
    "schemaType": "enum",
    "modelImplicit": false,
    "modelPath": "(resource) realtime > (model) noise_reduction_type",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",
      "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription > (property) model": {
    "kind": "HttpDeclProperty",
    "docstring": "The transcription model used for source transcript deltas.",
    "key": "model",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription/anyOf/0/properties/model",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "near_field"
    }
  },
  "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "far_field"
    }
  },
  "(resource) realtime > (model) noise_reduction_type > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/NoiseReductionType",
    "ident": "NoiseReductionType",
    "type": {
      "kind": "HttpTypeUnion",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "near_field"
        },
        {
          "kind": "HttpTypeLiteral",
          "literal": "far_field"
        }
      ],
      "oasRef": "#/components/schemas/NoiseReductionType"
    },
    "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",
      "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1"
    ]
  }
}

Example

{
  "type": "session.created",
  "event_id": "event_123",
  "session": {
    "id": "sess_123",
    "type": "translation",
    "model": "gpt-realtime-translate",
    "expires_at": 1714857600,
    "audio": {
      "input": {
        "transcription": {
          "model": "gpt-realtime-whisper",
          "language": "en"
        },
        "noise_reduction": {
          "type": "near_field"
        }
      },
      "output": {
        "language": "fr"
      }
    }
  }
}

session.updated

Returned when a translation session is updated with a session.update event, unless there is an error.

Schema

Schema name: RealtimeTranslationServerEventSessionUpdated

{
  "(resource) realtime > (model) realtime_translation_session_updated_event > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated",
    "ident": "RealtimeTranslationSessionUpdatedEvent",
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "event_id"
        },
        {
          "ident": "session"
        },
        {
          "ident": "type"
        }
      ]
    },
    "docstring": "Returned when a translation session is updated with a `session.update` event,\nunless there is an error.\n",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) event_id",
      "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) session",
      "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) type"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) event_id": {
    "kind": "HttpDeclProperty",
    "docstring": "The unique ID of the server event.",
    "key": "event_id",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/event_id",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) session": {
    "kind": "HttpDeclProperty",
    "title": "Realtime translation session",
    "docstring": "The translation session configuration.",
    "key": "session",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeReference",
      "ident": "RealtimeTranslationSession",
      "$ref": "(resource) realtime > (model) realtime_translation_session > (schema)"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/session",
    "deprecated": false,
    "schemaType": "object",
    "modelImplicit": false,
    "modelPath": "(resource) realtime > (model) realtime_translation_session",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) type": {
    "kind": "HttpDeclProperty",
    "docstring": "The event type, must be `session.updated`.",
    "key": "type",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeUnion",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "session.updated"
        }
      ],
      "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/type"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/type",
    "deprecated": false,
    "schemaType": "enum",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) type > (member) 0"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id": {
    "kind": "HttpDeclProperty",
    "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n",
    "key": "id",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/id",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio": {
    "kind": "HttpDeclProperty",
    "docstring": "Configuration for translation input and output audio.\n",
    "key": "audio",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "input"
        },
        {
          "ident": "output"
        }
      ]
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio",
    "deprecated": false,
    "schemaType": "object",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at": {
    "kind": "HttpDeclProperty",
    "docstring": "Expiration timestamp for the session, in seconds since epoch.",
    "key": "expires_at",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeNumber"
    },
    "constraints": {
      "format": "unixtime"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/expires_at",
    "deprecated": false,
    "schemaType": "integer",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model": {
    "kind": "HttpDeclProperty",
    "docstring": "The Realtime translation model used for this session. This field is set at\nsession creation and cannot be changed with `session.update`.\n",
    "key": "model",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/model",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type": {
    "kind": "HttpDeclProperty",
    "docstring": "The session type. Always `translation` for Realtime translation sessions.\n",
    "key": "type",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeUnion",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "translation"
        }
      ],
      "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type",
    "deprecated": false,
    "schemaType": "enum",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type > (member) 0"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/RealtimeTranslationSession",
    "ident": "RealtimeTranslationSession",
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "id"
        },
        {
          "ident": "audio"
        },
        {
          "ident": "expires_at"
        },
        {
          "ident": "model"
        },
        {
          "ident": "type"
        }
      ]
    },
    "docstring": "A Realtime translation session. Translation sessions continuously translate input\naudio into the configured output language.\n",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) type > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "session.updated"
    }
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input": {
    "kind": "HttpDeclProperty",
    "key": "input",
    "optional": true,
    "nullable": false,
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "noise_reduction"
        },
        {
          "ident": "transcription"
        }
      ]
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input",
    "deprecated": false,
    "schemaType": "object",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction",
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output": {
    "kind": "HttpDeclProperty",
    "key": "output",
    "optional": true,
    "nullable": false,
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "language"
        }
      ]
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output",
    "deprecated": false,
    "schemaType": "object",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output > (property) language"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "translation"
    }
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction": {
    "kind": "HttpDeclProperty",
    "docstring": "Optional input noise reduction.\n",
    "key": "noise_reduction",
    "optional": true,
    "nullable": true,
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "type"
        }
      ]
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction",
    "deprecated": false,
    "schemaType": "object",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription": {
    "kind": "HttpDeclProperty",
    "docstring": "Optional source-language transcription. When configured, the server emits\n`session.input_transcript.delta` events. Translation itself still runs from\nthe input audio stream.\n",
    "key": "transcription",
    "optional": true,
    "nullable": true,
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "model"
        }
      ]
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription",
    "deprecated": false,
    "schemaType": "object",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription > (property) model"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output > (property) language": {
    "kind": "HttpDeclProperty",
    "docstring": "Target language for translated output audio and transcript deltas.\n",
    "key": "language",
    "optional": true,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output/properties/language",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": {
    "kind": "HttpDeclProperty",
    "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",
    "key": "type",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeReference",
      "ident": "NoiseReductionType",
      "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction/anyOf/0/properties/type",
    "deprecated": false,
    "schemaType": "enum",
    "modelImplicit": false,
    "modelPath": "(resource) realtime > (model) noise_reduction_type",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",
      "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription > (property) model": {
    "kind": "HttpDeclProperty",
    "docstring": "The transcription model used for source transcript deltas.",
    "key": "model",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription/anyOf/0/properties/model",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "near_field"
    }
  },
  "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "far_field"
    }
  },
  "(resource) realtime > (model) noise_reduction_type > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/NoiseReductionType",
    "ident": "NoiseReductionType",
    "type": {
      "kind": "HttpTypeUnion",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "near_field"
        },
        {
          "kind": "HttpTypeLiteral",
          "literal": "far_field"
        }
      ],
      "oasRef": "#/components/schemas/NoiseReductionType"
    },
    "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",
      "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1"
    ]
  }
}

Example

{
  "type": "session.updated",
  "event_id": "event_124",
  "session": {
    "id": "sess_123",
    "type": "translation",
    "model": "gpt-realtime-translate",
    "expires_at": 1714857600,
    "audio": {
      "input": {
        "transcription": {
          "model": "gpt-realtime-whisper",
          "language": "en"
        },
        "noise_reduction": {
          "type": "near_field"
        }
      },
      "output": {
        "language": "es"
      }
    }
  }
}

session.closed

Returned when a realtime translation session is closed.

Schema

Schema name: RealtimeTranslationServerEventSessionClosed

{
  "(resource) realtime > (model) realtime_translation_session_closed_event > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed",
    "ident": "RealtimeTranslationSessionClosedEvent",
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "event_id"
        },
        {
          "ident": "type"
        }
      ]
    },
    "docstring": "Returned when a realtime translation session is closed.\n",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) event_id",
      "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) type"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) event_id": {
    "kind": "HttpDeclProperty",
    "docstring": "The unique ID of the server event.",
    "key": "event_id",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed/properties/event_id",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) type": {
    "kind": "HttpDeclProperty",
    "docstring": "The event type, must be `session.closed`.",
    "key": "type",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeUnion",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "session.closed"
        }
      ],
      "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed/properties/type"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed/properties/type",
    "deprecated": false,
    "schemaType": "enum",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) type > (member) 0"
    ]
  },
  "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) type > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "session.closed"
    }
  }
}

Example

{
  "event_id": "event_987",
  "type": "session.closed"
}

session.input_transcript.delta

Returned when optional source-language transcript text is available. This event is emitted only when audio.input.transcription is configured.

Transcript deltas are append-only text fragments. Clients should not insert unconditional spaces between deltas.

Schema

Schema name: RealtimeTranslationServerEventSessionInputTranscriptDelta

{
  "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta",
    "ident": "RealtimeTranslationInputTranscriptDeltaEvent",
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "delta"
        },
        {
          "ident": "event_id"
        },
        {
          "ident": "type"
        },
        {
          "ident": "elapsed_ms"
        }
      ]
    },
    "docstring": "Returned when optional source-language transcript text is available. This event\nis emitted only when `audio.input.transcription` is configured.\n\nTranscript deltas are append-only text fragments. Clients should not insert\nunconditional spaces between deltas.\n",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) delta",
      "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) event_id",
      "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) type",
      "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) elapsed_ms"
    ]
  },
  "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) delta": {
    "kind": "HttpDeclProperty",
    "docstring": "Append-only source-language transcript text.",
    "key": "delta",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/delta",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) event_id": {
    "kind": "HttpDeclProperty",
    "docstring": "The unique ID of the server event.",
    "key": "event_id",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/event_id",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) type": {
    "kind": "HttpDeclProperty",
    "docstring": "The event type, must be `session.input_transcript.delta`.",
    "key": "type",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeUnion",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "session.input_transcript.delta"
        }
      ],
      "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/type"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/type",
    "deprecated": false,
    "schemaType": "enum",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) type > (member) 0"
    ]
  },
  "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) elapsed_ms": {
    "kind": "HttpDeclProperty",
    "docstring": "Timing metadata for stream alignment, derived from the translation frame\nwhen available. It advances in 200 ms increments, but multiple transcript\ndeltas may share the same `elapsed_ms`. Treat it as alignment metadata,\nnot a unique transcript-delta identifier.\n",
    "key": "elapsed_ms",
    "optional": true,
    "nullable": true,
    "type": {
      "kind": "HttpTypeNumber"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/elapsed_ms",
    "deprecated": false,
    "schemaType": "integer",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) type > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "session.input_transcript.delta"
    }
  }
}

Example

{
  "event_id": "event_125",
  "type": "session.input_transcript.delta",
  "delta": " hear",
  "elapsed_ms": 1200
}

session.output_transcript.delta

Returned when translated transcript text is available.

Transcript deltas are append-only text fragments. Clients should not insert unconditional spaces between deltas.

Schema

Schema name: RealtimeTranslationServerEventSessionOutputTranscriptDelta

{
  "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta",
    "ident": "RealtimeTranslationOutputTranscriptDeltaEvent",
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "delta"
        },
        {
          "ident": "event_id"
        },
        {
          "ident": "type"
        },
        {
          "ident": "elapsed_ms"
        }
      ]
    },
    "docstring": "Returned when translated transcript text is available.\n\nTranscript deltas are append-only text fragments. Clients should not insert\nunconditional spaces between deltas.\n",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) delta",
      "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) event_id",
      "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) type",
      "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) elapsed_ms"
    ]
  },
  "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) delta": {
    "kind": "HttpDeclProperty",
    "docstring": "Append-only transcript text for the translated output audio.",
    "key": "delta",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/delta",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) event_id": {
    "kind": "HttpDeclProperty",
    "docstring": "The unique ID of the server event.",
    "key": "event_id",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/event_id",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) type": {
    "kind": "HttpDeclProperty",
    "docstring": "The event type, must be `session.output_transcript.delta`.",
    "key": "type",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeUnion",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "session.output_transcript.delta"
        }
      ],
      "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/type"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/type",
    "deprecated": false,
    "schemaType": "enum",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) type > (member) 0"
    ]
  },
  "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) elapsed_ms": {
    "kind": "HttpDeclProperty",
    "docstring": "Timing metadata for stream alignment, derived from the translation frame\nwhen available. It advances in 200 ms increments, but multiple transcript\ndeltas may share the same `elapsed_ms`. Treat it as alignment metadata,\nnot a unique transcript-delta identifier.\n",
    "key": "elapsed_ms",
    "optional": true,
    "nullable": true,
    "type": {
      "kind": "HttpTypeNumber"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/elapsed_ms",
    "deprecated": false,
    "schemaType": "integer",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) type > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "session.output_transcript.delta"
    }
  }
}

Example

{
  "event_id": "event_124",
  "type": "session.output_transcript.delta",
  "delta": " escuch",
  "elapsed_ms": 1200
}

session.output_audio.delta

Returned when translated output audio is available. Output audio deltas are 200 ms frames of PCM16 audio.

Schema

Schema name: RealtimeTranslationServerEventSessionOutputAudioDelta

{
  "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta",
    "ident": "RealtimeTranslationOutputAudioDeltaEvent",
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "delta"
        },
        {
          "ident": "event_id"
        },
        {
          "ident": "type"
        },
        {
          "ident": "channels"
        },
        {
          "ident": "elapsed_ms"
        },
        {
          "ident": "format"
        },
        {
          "ident": "sample_rate"
        }
      ]
    },
    "docstring": "Returned when translated output audio is available. Output audio deltas are\n200 ms frames of PCM16 audio.\n",
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) delta",
      "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) event_id",
      "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) type",
      "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) channels",
      "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) elapsed_ms",
      "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) format",
      "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) sample_rate"
    ]
  },
  "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) delta": {
    "kind": "HttpDeclProperty",
    "docstring": "Base64-encoded translated audio data.",
    "key": "delta",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/delta",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) event_id": {
    "kind": "HttpDeclProperty",
    "docstring": "The unique ID of the server event.",
    "key": "event_id",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeString"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/event_id",
    "deprecated": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) type": {
    "kind": "HttpDeclProperty",
    "docstring": "The event type, must be `session.output_audio.delta`.",
    "key": "type",
    "optional": false,
    "nullable": false,
    "type": {
      "kind": "HttpTypeUnion",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "session.output_audio.delta"
        }
      ],
      "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/type"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/type",
    "deprecated": false,
    "schemaType": "enum",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) type > (member) 0"
    ]
  },
  "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) channels": {
    "kind": "HttpDeclProperty",
    "docstring": "Number of audio channels.",
    "key": "channels",
    "optional": true,
    "nullable": false,
    "default": 1,
    "type": {
      "kind": "HttpTypeNumber"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/channels",
    "deprecated": false,
    "schemaType": "integer",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) elapsed_ms": {
    "kind": "HttpDeclProperty",
    "docstring": "Timing metadata for stream alignment, derived from the translation frame\nwhen available. Treat `elapsed_ms` as alignment metadata, not a unique\nevent identifier.\n",
    "key": "elapsed_ms",
    "optional": true,
    "nullable": true,
    "type": {
      "kind": "HttpTypeNumber"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/elapsed_ms",
    "deprecated": false,
    "schemaType": "integer",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) format": {
    "kind": "HttpDeclProperty",
    "docstring": "Audio encoding for `delta`.",
    "key": "format",
    "optional": true,
    "nullable": false,
    "type": {
      "kind": "HttpTypeUnion",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "pcm16"
        }
      ],
      "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/format"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/format",
    "deprecated": false,
    "schemaType": "enum",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) format > (member) 0"
    ]
  },
  "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) sample_rate": {
    "kind": "HttpDeclProperty",
    "docstring": "Sample rate of the audio delta.",
    "key": "sample_rate",
    "optional": true,
    "nullable": false,
    "default": 24000,
    "type": {
      "kind": "HttpTypeNumber"
    },
    "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/sample_rate",
    "deprecated": false,
    "schemaType": "integer",
    "children": []
  },
  "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) type > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "session.output_audio.delta"
    }
  },
  "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) format > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "pcm16"
    }
  }
}

Example

{
  "event_id": "event_123",
  "type": "session.output_audio.delta",
  "delta": "Base64EncodedAudioDelta",
  "sample_rate": 24000,
  "channels": 1,
  "format": "pcm16",
  "elapsed_ms": 1200
}

resources/realtime/translation-server-events.md +1699 −0 created

1# Realtime translation server events

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

5## error

7Returned when an error occurs, which could be a client problem or a server

8problem. Most errors are recoverable and the session will stay open, we

9recommend to implementors to monitor and log error messages by default.

11### Schema

13Schema name: `RealtimeServerEventError`

15```json

16{

17 "(resource) realtime > (model) realtime_error_event > (schema)": {

18 "kind": "HttpDeclTypeAlias",

19 "oasRef": "#/components/schemas/RealtimeServerEventError",

20 "ident": "RealtimeErrorEvent",

21 "type": {

22 "kind": "HttpTypeObject",

23 "members": [

24 {

25 "ident": "error"

26 },

27 {

28 "ident": "event_id"

29 },

30 {

31 "ident": "type"

32 }

33 ]

34 },

35 "docstring": "Returned when an error occurs, which could be a client problem or a server\nproblem. Most errors are recoverable and the session will stay open, we\nrecommend to implementors to monitor and log error messages by default.\n",

36 "childrenParentSchema": "object",

37 "children": [

38 "(resource) realtime > (model) realtime_error_event > (schema) > (property) error",

39 "(resource) realtime > (model) realtime_error_event > (schema) > (property) event_id",

40 "(resource) realtime > (model) realtime_error_event > (schema) > (property) type"

41 ]

42 },

43 "(resource) realtime > (model) realtime_error_event > (schema) > (property) error": {

44 "kind": "HttpDeclProperty",

45 "docstring": "Details of the error.",

46 "key": "error",

47 "optional": false,

48 "nullable": false,

49 "type": {

50 "kind": "HttpTypeReference",

51 "ident": "RealtimeError",

52 "$ref": "(resource) realtime > (model) realtime_error > (schema)"

53 },

54 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error",

55 "deprecated": false,

56 "schemaType": "object",

57 "modelImplicit": false,

58 "modelPath": "(resource) realtime > (model) realtime_error",

59 "childrenParentSchema": "object",

60 "children": [

61 "(resource) realtime > (model) realtime_error > (schema) > (property) message",

62 "(resource) realtime > (model) realtime_error > (schema) > (property) type",

63 "(resource) realtime > (model) realtime_error > (schema) > (property) code",

64 "(resource) realtime > (model) realtime_error > (schema) > (property) event_id",

65 "(resource) realtime > (model) realtime_error > (schema) > (property) param"

66 ]

67 },

68 "(resource) realtime > (model) realtime_error_event > (schema) > (property) event_id": {

69 "kind": "HttpDeclProperty",

70 "docstring": "The unique ID of the server event.",

71 "key": "event_id",

72 "optional": false,

73 "nullable": false,

74 "type": {

75 "kind": "HttpTypeString"

76 },

77 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/event_id",

78 "deprecated": false,

79 "schemaType": "string",

80 "children": []

81 },

82 "(resource) realtime > (model) realtime_error_event > (schema) > (property) type": {

83 "kind": "HttpDeclProperty",

84 "docstring": "The event type, must be `error`.",

85 "key": "type",

86 "optional": false,

87 "nullable": false,

88 "type": {

89 "kind": "HttpTypeUnion",

90 "types": [

91 {

92 "kind": "HttpTypeLiteral",

93 "literal": "error"

94 }

95 ],

96 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/type"

97 },

98 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/type",

99 "deprecated": false,

100 "schemaType": "enum",

101 "childrenParentSchema": "enum",

102 "children": [

103 "(resource) realtime > (model) realtime_error_event > (schema) > (property) type > (member) 0"

104 ]

105 },

106 "(resource) realtime > (model) realtime_error > (schema) > (property) message": {

107 "kind": "HttpDeclProperty",

108 "docstring": "A human-readable error message.",

109 "key": "message",

110 "optional": false,

111 "nullable": false,

112 "type": {

113 "kind": "HttpTypeString"

114 },

115 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/message",

116 "deprecated": false,

117 "schemaType": "string",

118 "children": []

119 },

120 "(resource) realtime > (model) realtime_error > (schema) > (property) type": {

121 "kind": "HttpDeclProperty",

122 "docstring": "The type of error (e.g., \"invalid_request_error\", \"server_error\").\n",

123 "key": "type",

124 "optional": false,

125 "nullable": false,

126 "type": {

127 "kind": "HttpTypeString"

128 },

129 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/type",

130 "deprecated": false,

131 "schemaType": "string",

132 "children": []

133 },

134 "(resource) realtime > (model) realtime_error > (schema) > (property) code": {

135 "kind": "HttpDeclProperty",

136 "docstring": "Error code, if any.",

137 "key": "code",

138 "optional": true,

139 "nullable": true,

140 "type": {

141 "kind": "HttpTypeString"

142 },

143 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/code",

144 "deprecated": false,

145 "schemaType": "string",

146 "children": []

147 },

148 "(resource) realtime > (model) realtime_error > (schema) > (property) event_id": {

149 "kind": "HttpDeclProperty",

150 "docstring": "The event_id of the client event that caused the error, if applicable.\n",

151 "key": "event_id",

152 "optional": true,

153 "nullable": true,

154 "type": {

155 "kind": "HttpTypeString"

156 },

157 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/event_id",

158 "deprecated": false,

159 "schemaType": "string",

160 "children": []

161 },

162 "(resource) realtime > (model) realtime_error > (schema) > (property) param": {

163 "kind": "HttpDeclProperty",

164 "docstring": "Parameter related to the error, if any.",

165 "key": "param",

166 "optional": true,

167 "nullable": true,

168 "type": {

169 "kind": "HttpTypeString"

170 },

171 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/param",

172 "deprecated": false,

173 "schemaType": "string",

174 "children": []

175 },

176 "(resource) realtime > (model) realtime_error > (schema)": {

177 "kind": "HttpDeclTypeAlias",

178 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error",

179 "ident": "RealtimeError",

180 "type": {

181 "kind": "HttpTypeObject",

182 "members": [

183 {

184 "ident": "message"

185 },

186 {

187 "ident": "type"

188 },

189 {

190 "ident": "code"

191 },

192 {

193 "ident": "event_id"

194 },

195 {

196 "ident": "param"

197 }

198 ]

199 },

200 "docstring": "Details of the error.",

201 "childrenParentSchema": "object",

202 "children": [

203 "(resource) realtime > (model) realtime_error > (schema) > (property) message",

204 "(resource) realtime > (model) realtime_error > (schema) > (property) type",

205 "(resource) realtime > (model) realtime_error > (schema) > (property) code",

206 "(resource) realtime > (model) realtime_error > (schema) > (property) event_id",

207 "(resource) realtime > (model) realtime_error > (schema) > (property) param"

208 ]

209 },

210 "(resource) realtime > (model) realtime_error_event > (schema) > (property) type > (member) 0": {

211 "kind": "HttpDeclReference",

212 "type": {

213 "kind": "HttpTypeLiteral",

214 "literal": "error"

215 }

216 }

217}

218```

219

220### Example

221

222```json

223{

224 "event_id": "event_890",

225 "type": "error",

226 "error": {

227 "type": "invalid_request_error",

228 "code": "invalid_event",

229 "message": "The 'type' field is missing.",

230 "param": null,

231 "event_id": "event_567"

232 }

233}

234```

235

236## session.created

237

238Returned when a translation session is created. Emitted automatically when a

239new connection is established as the first server event. This event contains

240the default translation session configuration.

241

242### Schema

243

244Schema name: `RealtimeTranslationServerEventSessionCreated`

245

246```json

247{

248 "(resource) realtime > (model) realtime_translation_session_created_event > (schema)": {

249 "kind": "HttpDeclTypeAlias",

250 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated",

251 "ident": "RealtimeTranslationSessionCreatedEvent",

252 "type": {

253 "kind": "HttpTypeObject",

254 "members": [

255 {

256 "ident": "event_id"

257 },

258 {

259 "ident": "session"

260 },

261 {

262 "ident": "type"

263 }

264 ]

265 },

266 "docstring": "Returned when a translation session is created. Emitted automatically when a\nnew connection is established as the first server event. This event contains\nthe default translation session configuration.\n",

267 "childrenParentSchema": "object",

268 "children": [

269 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) event_id",

270 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) session",

271 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) type"

272 ]

273 },

274 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) event_id": {

275 "kind": "HttpDeclProperty",

276 "docstring": "The unique ID of the server event.",

277 "key": "event_id",

278 "optional": false,

279 "nullable": false,

280 "type": {

281 "kind": "HttpTypeString"

282 },

283 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/event_id",

284 "deprecated": false,

285 "schemaType": "string",

286 "children": []

287 },

288 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) session": {

289 "kind": "HttpDeclProperty",

290 "title": "Realtime translation session",

291 "docstring": "The translation session configuration.",

292 "key": "session",

293 "optional": false,

294 "nullable": false,

295 "type": {

296 "kind": "HttpTypeReference",

297 "ident": "RealtimeTranslationSession",

298 "$ref": "(resource) realtime > (model) realtime_translation_session > (schema)"

299 },

300 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/session",

301 "deprecated": false,

302 "schemaType": "object",

303 "modelImplicit": false,

304 "modelPath": "(resource) realtime > (model) realtime_translation_session",

305 "childrenParentSchema": "object",

306 "children": [

307 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id",

308 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio",

309 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at",

310 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model",

311 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type"

312 ]

313 },

314 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) type": {

315 "kind": "HttpDeclProperty",

316 "docstring": "The event type, must be `session.created`.",

317 "key": "type",

318 "optional": false,

319 "nullable": false,

320 "type": {

321 "kind": "HttpTypeUnion",

322 "types": [

323 {

324 "kind": "HttpTypeLiteral",

325 "literal": "session.created"

326 }

327 ],

328 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/type"

329 },

330 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/type",

331 "deprecated": false,

332 "schemaType": "enum",

333 "childrenParentSchema": "enum",

334 "children": [

335 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) type > (member) 0"

336 ]

337 },

338 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id": {

339 "kind": "HttpDeclProperty",

340 "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n",

341 "key": "id",

342 "optional": false,

343 "nullable": false,

344 "type": {

345 "kind": "HttpTypeString"

346 },

347 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/id",

348 "deprecated": false,

349 "schemaType": "string",

350 "children": []

351 },

352 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio": {

353 "kind": "HttpDeclProperty",

354 "docstring": "Configuration for translation input and output audio.\n",

355 "key": "audio",

356 "optional": false,

357 "nullable": false,

358 "type": {

359 "kind": "HttpTypeObject",

360 "members": [

361 {

362 "ident": "input"

363 },

364 {

365 "ident": "output"

366 }

367 ]

368 },

369 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio",

370 "deprecated": false,

371 "schemaType": "object",

372 "childrenParentSchema": "object",

373 "children": [

374 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input",

375 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output"

376 ]

377 },

378 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at": {

379 "kind": "HttpDeclProperty",

380 "docstring": "Expiration timestamp for the session, in seconds since epoch.",

381 "key": "expires_at",

382 "optional": false,

383 "nullable": false,

384 "type": {

385 "kind": "HttpTypeNumber"

386 },

387 "constraints": {

388 "format": "unixtime"

389 },

390 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/expires_at",

391 "deprecated": false,

392 "schemaType": "integer",

393 "children": []

394 },

395 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model": {

396 "kind": "HttpDeclProperty",

397 "docstring": "The Realtime translation model used for this session. This field is set at\nsession creation and cannot be changed with `session.update`.\n",

398 "key": "model",

399 "optional": false,

400 "nullable": false,

401 "type": {

402 "kind": "HttpTypeString"

403 },

404 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/model",

405 "deprecated": false,

406 "schemaType": "string",

407 "children": []

408 },

409 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type": {

410 "kind": "HttpDeclProperty",

411 "docstring": "The session type. Always `translation` for Realtime translation sessions.\n",

412 "key": "type",

413 "optional": false,

414 "nullable": false,

415 "type": {

416 "kind": "HttpTypeUnion",

417 "types": [

418 {

419 "kind": "HttpTypeLiteral",

420 "literal": "translation"

421 }

422 ],

423 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type"

424 },

425 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type",

426 "deprecated": false,

427 "schemaType": "enum",

428 "childrenParentSchema": "enum",

429 "children": [

430 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type > (member) 0"

431 ]

432 },

433 "(resource) realtime > (model) realtime_translation_session > (schema)": {

434 "kind": "HttpDeclTypeAlias",

435 "oasRef": "#/components/schemas/RealtimeTranslationSession",

436 "ident": "RealtimeTranslationSession",

437 "type": {

438 "kind": "HttpTypeObject",

439 "members": [

440 {

441 "ident": "id"

442 },

443 {

444 "ident": "audio"

445 },

446 {

447 "ident": "expires_at"

448 },

449 {

450 "ident": "model"

451 },

452 {

453 "ident": "type"

454 }

455 ]

456 },

457 "docstring": "A Realtime translation session. Translation sessions continuously translate input\naudio into the configured output language.\n",

458 "childrenParentSchema": "object",

459 "children": [

460 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id",

461 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio",

462 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at",

463 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model",

464 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type"

465 ]

466 },

467 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) type > (member) 0": {

468 "kind": "HttpDeclReference",

469 "type": {

470 "kind": "HttpTypeLiteral",

471 "literal": "session.created"

472 }

473 },

474 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input": {

475 "kind": "HttpDeclProperty",

476 "key": "input",

477 "optional": true,

478 "nullable": false,

479 "type": {

480 "kind": "HttpTypeObject",

481 "members": [

482 {

483 "ident": "noise_reduction"

484 },

485 {

486 "ident": "transcription"

487 }

488 ]

489 },

490 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input",

491 "deprecated": false,

492 "schemaType": "object",

493 "childrenParentSchema": "object",

494 "children": [

495 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction",

496 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription"

497 ]

498 },

499 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output": {

500 "kind": "HttpDeclProperty",

501 "key": "output",

502 "optional": true,

503 "nullable": false,

504 "type": {

505 "kind": "HttpTypeObject",

506 "members": [

507 {

508 "ident": "language"

509 }

510 ]

511 },

512 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output",

513 "deprecated": false,

514 "schemaType": "object",

515 "childrenParentSchema": "object",

516 "children": [

517 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output > (property) language"

518 ]

519 },

520 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type > (member) 0": {

521 "kind": "HttpDeclReference",

522 "type": {

523 "kind": "HttpTypeLiteral",

524 "literal": "translation"

525 }

526 },

527 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction": {

528 "kind": "HttpDeclProperty",

529 "docstring": "Optional input noise reduction.\n",

530 "key": "noise_reduction",

531 "optional": true,

532 "nullable": true,

533 "type": {

534 "kind": "HttpTypeObject",

535 "members": [

536 {

537 "ident": "type"

538 }

539 ]

540 },

541 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction",

542 "deprecated": false,

543 "schemaType": "object",

544 "childrenParentSchema": "object",

545 "children": [

546 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type"

547 ]

548 },

549 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription": {

550 "kind": "HttpDeclProperty",

551 "docstring": "Optional source-language transcription. When configured, the server emits\n`session.input_transcript.delta` events. Translation itself still runs from\nthe input audio stream.\n",

552 "key": "transcription",

553 "optional": true,

554 "nullable": true,

555 "type": {

556 "kind": "HttpTypeObject",

557 "members": [

558 {

559 "ident": "model"

560 }

561 ]

562 },

563 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription",

564 "deprecated": false,

565 "schemaType": "object",

566 "childrenParentSchema": "object",

567 "children": [

568 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription > (property) model"

569 ]

570 },

571 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output > (property) language": {

572 "kind": "HttpDeclProperty",

573 "docstring": "Target language for translated output audio and transcript deltas.\n",

574 "key": "language",

575 "optional": true,

576 "nullable": false,

577 "type": {

578 "kind": "HttpTypeString"

579 },

580 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output/properties/language",

581 "deprecated": false,

582 "schemaType": "string",

583 "children": []

584 },

585 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": {

586 "kind": "HttpDeclProperty",

587 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",

588 "key": "type",

589 "optional": false,

590 "nullable": false,

591 "type": {

592 "kind": "HttpTypeReference",

593 "ident": "NoiseReductionType",

594 "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)"

595 },

596 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction/anyOf/0/properties/type",

597 "deprecated": false,

598 "schemaType": "enum",

599 "modelImplicit": false,

600 "modelPath": "(resource) realtime > (model) noise_reduction_type",

601 "childrenParentSchema": "enum",

602 "children": [

603 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",

604 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1"

605 ]

606 },

607 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription > (property) model": {

608 "kind": "HttpDeclProperty",

609 "docstring": "The transcription model used for source transcript deltas.",

610 "key": "model",

611 "optional": false,

612 "nullable": false,

613 "type": {

614 "kind": "HttpTypeString"

615 },

616 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription/anyOf/0/properties/model",

617 "deprecated": false,

618 "schemaType": "string",

619 "children": []

620 },

621 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0": {

622 "kind": "HttpDeclReference",

623 "type": {

624 "kind": "HttpTypeLiteral",

625 "literal": "near_field"

626 }

627 },

628 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1": {

629 "kind": "HttpDeclReference",

630 "type": {

631 "kind": "HttpTypeLiteral",

632 "literal": "far_field"

633 }

634 },

635 "(resource) realtime > (model) noise_reduction_type > (schema)": {

636 "kind": "HttpDeclTypeAlias",

637 "oasRef": "#/components/schemas/NoiseReductionType",

638 "ident": "NoiseReductionType",

639 "type": {

640 "kind": "HttpTypeUnion",

641 "types": [

642 {

643 "kind": "HttpTypeLiteral",

644 "literal": "near_field"

645 },

646 {

647 "kind": "HttpTypeLiteral",

648 "literal": "far_field"

649 }

650 ],

651 "oasRef": "#/components/schemas/NoiseReductionType"

652 },

653 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",

654 "childrenParentSchema": "enum",

655 "children": [

656 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",

657 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1"

658 ]

659 }

660}

661```

662

663### Example

664

665```json

666{

667 "type": "session.created",

668 "event_id": "event_123",

669 "session": {

670 "id": "sess_123",

671 "type": "translation",

672 "model": "gpt-realtime-translate",

673 "expires_at": 1714857600,

674 "audio": {

675 "input": {

676 "transcription": {

677 "model": "gpt-realtime-whisper",

678 "language": "en"

679 },

680 "noise_reduction": {

681 "type": "near_field"

682 }

683 },

684 "output": {

685 "language": "fr"

686 }

687 }

688 }

689}

690```

691

692## session.updated

693

694Returned when a translation session is updated with a `session.update` event,

695unless there is an error.

696

697### Schema

698

699Schema name: `RealtimeTranslationServerEventSessionUpdated`

700

701```json

702{

703 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema)": {

704 "kind": "HttpDeclTypeAlias",

705 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated",

706 "ident": "RealtimeTranslationSessionUpdatedEvent",

707 "type": {

708 "kind": "HttpTypeObject",

709 "members": [

710 {

711 "ident": "event_id"

712 },

713 {

714 "ident": "session"

715 },

716 {

717 "ident": "type"

718 }

719 ]

720 },

721 "docstring": "Returned when a translation session is updated with a `session.update` event,\nunless there is an error.\n",

722 "childrenParentSchema": "object",

723 "children": [

724 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) event_id",

725 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) session",

726 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) type"

727 ]

728 },

729 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) event_id": {

730 "kind": "HttpDeclProperty",

731 "docstring": "The unique ID of the server event.",

732 "key": "event_id",

733 "optional": false,

734 "nullable": false,

735 "type": {

736 "kind": "HttpTypeString"

737 },

738 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/event_id",

739 "deprecated": false,

740 "schemaType": "string",

741 "children": []

742 },

743 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) session": {

744 "kind": "HttpDeclProperty",

745 "title": "Realtime translation session",

746 "docstring": "The translation session configuration.",

747 "key": "session",

748 "optional": false,

749 "nullable": false,

750 "type": {

751 "kind": "HttpTypeReference",

752 "ident": "RealtimeTranslationSession",

753 "$ref": "(resource) realtime > (model) realtime_translation_session > (schema)"

754 },

755 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/session",

756 "deprecated": false,

757 "schemaType": "object",

758 "modelImplicit": false,

759 "modelPath": "(resource) realtime > (model) realtime_translation_session",

760 "childrenParentSchema": "object",

761 "children": [

762 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id",

763 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio",

764 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at",

765 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model",

766 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type"

767 ]

768 },

769 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) type": {

770 "kind": "HttpDeclProperty",

771 "docstring": "The event type, must be `session.updated`.",

772 "key": "type",

773 "optional": false,

774 "nullable": false,

775 "type": {

776 "kind": "HttpTypeUnion",

777 "types": [

778 {

779 "kind": "HttpTypeLiteral",

780 "literal": "session.updated"

781 }

782 ],

783 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/type"

784 },

785 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/type",

786 "deprecated": false,

787 "schemaType": "enum",

788 "childrenParentSchema": "enum",

789 "children": [

790 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) type > (member) 0"

791 ]

792 },

793 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id": {

794 "kind": "HttpDeclProperty",

795 "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n",

796 "key": "id",

797 "optional": false,

798 "nullable": false,

799 "type": {

800 "kind": "HttpTypeString"

801 },

802 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/id",

803 "deprecated": false,

804 "schemaType": "string",

805 "children": []

806 },

807 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio": {

808 "kind": "HttpDeclProperty",

809 "docstring": "Configuration for translation input and output audio.\n",

810 "key": "audio",

811 "optional": false,

812 "nullable": false,

813 "type": {

814 "kind": "HttpTypeObject",

815 "members": [

816 {

817 "ident": "input"

818 },

819 {

820 "ident": "output"

821 }

822 ]

823 },

824 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio",

825 "deprecated": false,

826 "schemaType": "object",

827 "childrenParentSchema": "object",

828 "children": [

829 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input",

830 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output"

831 ]

832 },

833 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at": {

834 "kind": "HttpDeclProperty",

835 "docstring": "Expiration timestamp for the session, in seconds since epoch.",

836 "key": "expires_at",

837 "optional": false,

838 "nullable": false,

839 "type": {

840 "kind": "HttpTypeNumber"

841 },

842 "constraints": {

843 "format": "unixtime"

844 },

845 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/expires_at",

846 "deprecated": false,

847 "schemaType": "integer",

848 "children": []

849 },

850 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model": {

851 "kind": "HttpDeclProperty",

852 "docstring": "The Realtime translation model used for this session. This field is set at\nsession creation and cannot be changed with `session.update`.\n",

853 "key": "model",

854 "optional": false,

855 "nullable": false,

856 "type": {

857 "kind": "HttpTypeString"

858 },

859 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/model",

860 "deprecated": false,

861 "schemaType": "string",

862 "children": []

863 },

864 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type": {

865 "kind": "HttpDeclProperty",

866 "docstring": "The session type. Always `translation` for Realtime translation sessions.\n",

867 "key": "type",

868 "optional": false,

869 "nullable": false,

870 "type": {

871 "kind": "HttpTypeUnion",

872 "types": [

873 {

874 "kind": "HttpTypeLiteral",

875 "literal": "translation"

876 }

877 ],

878 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type"

879 },

880 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type",

881 "deprecated": false,

882 "schemaType": "enum",

883 "childrenParentSchema": "enum",

884 "children": [

885 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type > (member) 0"

886 ]

887 },

888 "(resource) realtime > (model) realtime_translation_session > (schema)": {

889 "kind": "HttpDeclTypeAlias",

890 "oasRef": "#/components/schemas/RealtimeTranslationSession",

891 "ident": "RealtimeTranslationSession",

892 "type": {

893 "kind": "HttpTypeObject",

894 "members": [

895 {

896 "ident": "id"

897 },

898 {

899 "ident": "audio"

900 },

901 {

902 "ident": "expires_at"

903 },

904 {

905 "ident": "model"

906 },

907 {

908 "ident": "type"

909 }

910 ]

911 },

912 "docstring": "A Realtime translation session. Translation sessions continuously translate input\naudio into the configured output language.\n",

913 "childrenParentSchema": "object",

914 "children": [

915 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id",

916 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio",

917 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at",

918 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model",

919 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type"

920 ]

921 },

922 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) type > (member) 0": {

923 "kind": "HttpDeclReference",

924 "type": {

925 "kind": "HttpTypeLiteral",

926 "literal": "session.updated"

927 }

928 },

929 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input": {

930 "kind": "HttpDeclProperty",

931 "key": "input",

932 "optional": true,

933 "nullable": false,

934 "type": {

935 "kind": "HttpTypeObject",

936 "members": [

937 {

938 "ident": "noise_reduction"

939 },

940 {

941 "ident": "transcription"

942 }

943 ]

944 },

945 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input",

946 "deprecated": false,

947 "schemaType": "object",

948 "childrenParentSchema": "object",

949 "children": [

950 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction",

951 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription"

952 ]

953 },

954 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output": {

955 "kind": "HttpDeclProperty",

956 "key": "output",

957 "optional": true,

958 "nullable": false,

959 "type": {

960 "kind": "HttpTypeObject",

961 "members": [

962 {

963 "ident": "language"

964 }

965 ]

966 },

967 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output",

968 "deprecated": false,

969 "schemaType": "object",

970 "childrenParentSchema": "object",

971 "children": [

972 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output > (property) language"

973 ]

974 },

975 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type > (member) 0": {

976 "kind": "HttpDeclReference",

977 "type": {

978 "kind": "HttpTypeLiteral",

979 "literal": "translation"

980 }

981 },

982 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction": {

983 "kind": "HttpDeclProperty",

984 "docstring": "Optional input noise reduction.\n",

985 "key": "noise_reduction",

986 "optional": true,

987 "nullable": true,

988 "type": {

989 "kind": "HttpTypeObject",

990 "members": [

991 {

992 "ident": "type"

993 }

994 ]

995 },

996 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction",

997 "deprecated": false,

998 "schemaType": "object",

999 "childrenParentSchema": "object",

1000 "children": [

1001 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type"

1002 ]

1003 },

1004 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription": {

1005 "kind": "HttpDeclProperty",

1006 "docstring": "Optional source-language transcription. When configured, the server emits\n`session.input_transcript.delta` events. Translation itself still runs from\nthe input audio stream.\n",

1007 "key": "transcription",

1008 "optional": true,

1009 "nullable": true,

1010 "type": {

1011 "kind": "HttpTypeObject",

1012 "members": [

1013 {

1014 "ident": "model"

1015 }

1016 ]

1017 },

1018 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription",

1019 "deprecated": false,

1020 "schemaType": "object",

1021 "childrenParentSchema": "object",

1022 "children": [

1023 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription > (property) model"

1024 ]

1025 },

1026 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output > (property) language": {

1027 "kind": "HttpDeclProperty",

1028 "docstring": "Target language for translated output audio and transcript deltas.\n",

1029 "key": "language",

1030 "optional": true,

1031 "nullable": false,

1032 "type": {

1033 "kind": "HttpTypeString"

1034 },

1035 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output/properties/language",

1036 "deprecated": false,

1037 "schemaType": "string",

1038 "children": []

1039 },

1040 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": {

1041 "kind": "HttpDeclProperty",

1042 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",

1043 "key": "type",

1044 "optional": false,

1045 "nullable": false,

1046 "type": {

1047 "kind": "HttpTypeReference",

1048 "ident": "NoiseReductionType",

1049 "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)"

1050 },

1051 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction/anyOf/0/properties/type",

1052 "deprecated": false,

1053 "schemaType": "enum",

1054 "modelImplicit": false,

1055 "modelPath": "(resource) realtime > (model) noise_reduction_type",

1056 "childrenParentSchema": "enum",

1057 "children": [

1058 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",

1059 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1"

1060 ]

1061 },

1062 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription > (property) model": {

1063 "kind": "HttpDeclProperty",

1064 "docstring": "The transcription model used for source transcript deltas.",

1065 "key": "model",

1066 "optional": false,

1067 "nullable": false,

1068 "type": {

1069 "kind": "HttpTypeString"

1070 },

1071 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription/anyOf/0/properties/model",

1072 "deprecated": false,

1073 "schemaType": "string",

1074 "children": []

1075 },

1076 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0": {

1077 "kind": "HttpDeclReference",

1078 "type": {

1079 "kind": "HttpTypeLiteral",

1080 "literal": "near_field"

1081 }

1082 },

1083 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1": {

1084 "kind": "HttpDeclReference",

1085 "type": {

1086 "kind": "HttpTypeLiteral",

1087 "literal": "far_field"

1088 }

1089 },

1090 "(resource) realtime > (model) noise_reduction_type > (schema)": {

1091 "kind": "HttpDeclTypeAlias",

1092 "oasRef": "#/components/schemas/NoiseReductionType",

1093 "ident": "NoiseReductionType",

1094 "type": {

1095 "kind": "HttpTypeUnion",

1096 "types": [

1097 {

1098 "kind": "HttpTypeLiteral",

1099 "literal": "near_field"

1100 },

1101 {

1102 "kind": "HttpTypeLiteral",

1103 "literal": "far_field"

1104 }

1105 ],

1106 "oasRef": "#/components/schemas/NoiseReductionType"

1107 },

1108 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",

1109 "childrenParentSchema": "enum",

1110 "children": [

1111 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",

1112 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1"

1113 ]

1114 }

1115}

1116```

1117

1118### Example

1119

1120```json

1121{

1122 "type": "session.updated",

1123 "event_id": "event_124",

1124 "session": {

1125 "id": "sess_123",

1126 "type": "translation",

1127 "model": "gpt-realtime-translate",

1128 "expires_at": 1714857600,

1129 "audio": {

1130 "input": {

1131 "transcription": {

1132 "model": "gpt-realtime-whisper",

1133 "language": "en"

1134 },

1135 "noise_reduction": {

1136 "type": "near_field"

1137 }

1138 },

1139 "output": {

1140 "language": "es"

1141 }

1142 }

1143 }

1144}

1145```

1146

1147## session.closed

1148

1149Returned when a realtime translation session is closed.

1150

1151### Schema

1152

1153Schema name: `RealtimeTranslationServerEventSessionClosed`

1154

1155```json

1156{

1157 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema)": {

1158 "kind": "HttpDeclTypeAlias",

1159 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed",

1160 "ident": "RealtimeTranslationSessionClosedEvent",

1161 "type": {

1162 "kind": "HttpTypeObject",

1163 "members": [

1164 {

1165 "ident": "event_id"

1166 },

1167 {

1168 "ident": "type"

1169 }

1170 ]

1171 },

1172 "docstring": "Returned when a realtime translation session is closed.\n",

1173 "childrenParentSchema": "object",

1174 "children": [

1175 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) event_id",

1176 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) type"

1177 ]

1178 },

1179 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) event_id": {

1180 "kind": "HttpDeclProperty",

1181 "docstring": "The unique ID of the server event.",

1182 "key": "event_id",

1183 "optional": false,

1184 "nullable": false,

1185 "type": {

1186 "kind": "HttpTypeString"

1187 },

1188 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed/properties/event_id",

1189 "deprecated": false,

1190 "schemaType": "string",

1191 "children": []

1192 },

1193 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) type": {

1194 "kind": "HttpDeclProperty",

1195 "docstring": "The event type, must be `session.closed`.",

1196 "key": "type",

1197 "optional": false,

1198 "nullable": false,

1199 "type": {

1200 "kind": "HttpTypeUnion",

1201 "types": [

1202 {

1203 "kind": "HttpTypeLiteral",

1204 "literal": "session.closed"

1205 }

1206 ],

1207 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed/properties/type"

1208 },

1209 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed/properties/type",

1210 "deprecated": false,

1211 "schemaType": "enum",

1212 "childrenParentSchema": "enum",

1213 "children": [

1214 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) type > (member) 0"

1215 ]

1216 },

1217 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) type > (member) 0": {

1218 "kind": "HttpDeclReference",

1219 "type": {

1220 "kind": "HttpTypeLiteral",

1221 "literal": "session.closed"

1222 }

1223 }

1224}

1225```

1226

1227### Example

1228

1229```json

1230{

1231 "event_id": "event_987",

1232 "type": "session.closed"

1233}

1234```

1235

1236## session.input_transcript.delta

1237

1238Returned when optional source-language transcript text is available. This event

1239is emitted only when `audio.input.transcription` is configured.

1240

1241Transcript deltas are append-only text fragments. Clients should not insert

1242unconditional spaces between deltas.

1243

1244### Schema

1245

1246Schema name: `RealtimeTranslationServerEventSessionInputTranscriptDelta`

1247

1248```json

1249{

1250 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema)": {

1251 "kind": "HttpDeclTypeAlias",

1252 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta",

1253 "ident": "RealtimeTranslationInputTranscriptDeltaEvent",

1254 "type": {

1255 "kind": "HttpTypeObject",

1256 "members": [

1257 {

1258 "ident": "delta"

1259 },

1260 {

1261 "ident": "event_id"

1262 },

1263 {

1264 "ident": "type"

1265 },

1266 {

1267 "ident": "elapsed_ms"

1268 }

1269 ]

1270 },

1271 "docstring": "Returned when optional source-language transcript text is available. This event\nis emitted only when `audio.input.transcription` is configured.\n\nTranscript deltas are append-only text fragments. Clients should not insert\nunconditional spaces between deltas.\n",

1272 "childrenParentSchema": "object",

1273 "children": [

1274 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) delta",

1275 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) event_id",

1276 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) type",

1277 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) elapsed_ms"

1278 ]

1279 },

1280 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) delta": {

1281 "kind": "HttpDeclProperty",

1282 "docstring": "Append-only source-language transcript text.",

1283 "key": "delta",

1284 "optional": false,

1285 "nullable": false,

1286 "type": {

1287 "kind": "HttpTypeString"

1288 },

1289 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/delta",

1290 "deprecated": false,

1291 "schemaType": "string",

1292 "children": []

1293 },

1294 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) event_id": {

1295 "kind": "HttpDeclProperty",

1296 "docstring": "The unique ID of the server event.",

1297 "key": "event_id",

1298 "optional": false,

1299 "nullable": false,

1300 "type": {

1301 "kind": "HttpTypeString"

1302 },

1303 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/event_id",

1304 "deprecated": false,

1305 "schemaType": "string",

1306 "children": []

1307 },

1308 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) type": {

1309 "kind": "HttpDeclProperty",

1310 "docstring": "The event type, must be `session.input_transcript.delta`.",

1311 "key": "type",

1312 "optional": false,

1313 "nullable": false,

1314 "type": {

1315 "kind": "HttpTypeUnion",

1316 "types": [

1317 {

1318 "kind": "HttpTypeLiteral",

1319 "literal": "session.input_transcript.delta"

1320 }

1321 ],

1322 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/type"

1323 },

1324 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/type",

1325 "deprecated": false,

1326 "schemaType": "enum",

1327 "childrenParentSchema": "enum",

1328 "children": [

1329 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) type > (member) 0"

1330 ]

1331 },

1332 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) elapsed_ms": {

1333 "kind": "HttpDeclProperty",

1334 "docstring": "Timing metadata for stream alignment, derived from the translation frame\nwhen available. It advances in 200 ms increments, but multiple transcript\ndeltas may share the same `elapsed_ms`. Treat it as alignment metadata,\nnot a unique transcript-delta identifier.\n",

1335 "key": "elapsed_ms",

1336 "optional": true,

1337 "nullable": true,

1338 "type": {

1339 "kind": "HttpTypeNumber"

1340 },

1341 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/elapsed_ms",

1342 "deprecated": false,

1343 "schemaType": "integer",

1344 "children": []

1345 },

1346 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) type > (member) 0": {

1347 "kind": "HttpDeclReference",

1348 "type": {

1349 "kind": "HttpTypeLiteral",

1350 "literal": "session.input_transcript.delta"

1351 }

1352 }

1353}

1354```

1355

1356### Example

1357

1358```json

1359{

1360 "event_id": "event_125",

1361 "type": "session.input_transcript.delta",

1362 "delta": " hear",

1363 "elapsed_ms": 1200

1364}

1365```

1366

1367## session.output_transcript.delta

1368

1369Returned when translated transcript text is available.

1370

1371Transcript deltas are append-only text fragments. Clients should not insert

1372unconditional spaces between deltas.

1373

1374### Schema

1375

1376Schema name: `RealtimeTranslationServerEventSessionOutputTranscriptDelta`

1377

1378```json

1379{

1380 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema)": {

1381 "kind": "HttpDeclTypeAlias",

1382 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta",

1383 "ident": "RealtimeTranslationOutputTranscriptDeltaEvent",

1384 "type": {

1385 "kind": "HttpTypeObject",

1386 "members": [

1387 {

1388 "ident": "delta"

1389 },

1390 {

1391 "ident": "event_id"

1392 },

1393 {

1394 "ident": "type"

1395 },

1396 {

1397 "ident": "elapsed_ms"

1398 }

1399 ]

1400 },

1401 "docstring": "Returned when translated transcript text is available.\n\nTranscript deltas are append-only text fragments. Clients should not insert\nunconditional spaces between deltas.\n",

1402 "childrenParentSchema": "object",

1403 "children": [

1404 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) delta",

1405 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) event_id",

1406 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) type",

1407 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) elapsed_ms"

1408 ]

1409 },

1410 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) delta": {

1411 "kind": "HttpDeclProperty",

1412 "docstring": "Append-only transcript text for the translated output audio.",

1413 "key": "delta",

1414 "optional": false,

1415 "nullable": false,

1416 "type": {

1417 "kind": "HttpTypeString"

1418 },

1419 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/delta",

1420 "deprecated": false,

1421 "schemaType": "string",

1422 "children": []

1423 },

1424 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) event_id": {

1425 "kind": "HttpDeclProperty",

1426 "docstring": "The unique ID of the server event.",

1427 "key": "event_id",

1428 "optional": false,

1429 "nullable": false,

1430 "type": {

1431 "kind": "HttpTypeString"

1432 },

1433 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/event_id",

1434 "deprecated": false,

1435 "schemaType": "string",

1436 "children": []

1437 },

1438 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) type": {

1439 "kind": "HttpDeclProperty",

1440 "docstring": "The event type, must be `session.output_transcript.delta`.",

1441 "key": "type",

1442 "optional": false,

1443 "nullable": false,

1444 "type": {

1445 "kind": "HttpTypeUnion",

1446 "types": [

1447 {

1448 "kind": "HttpTypeLiteral",

1449 "literal": "session.output_transcript.delta"

1450 }

1451 ],

1452 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/type"

1453 },

1454 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/type",

1455 "deprecated": false,

1456 "schemaType": "enum",

1457 "childrenParentSchema": "enum",

1458 "children": [

1459 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) type > (member) 0"

1460 ]

1461 },

1462 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) elapsed_ms": {

1463 "kind": "HttpDeclProperty",

1464 "docstring": "Timing metadata for stream alignment, derived from the translation frame\nwhen available. It advances in 200 ms increments, but multiple transcript\ndeltas may share the same `elapsed_ms`. Treat it as alignment metadata,\nnot a unique transcript-delta identifier.\n",

1465 "key": "elapsed_ms",

1466 "optional": true,

1467 "nullable": true,

1468 "type": {

1469 "kind": "HttpTypeNumber"

1470 },

1471 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/elapsed_ms",

1472 "deprecated": false,

1473 "schemaType": "integer",

1474 "children": []

1475 },

1476 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) type > (member) 0": {

1477 "kind": "HttpDeclReference",

1478 "type": {

1479 "kind": "HttpTypeLiteral",

1480 "literal": "session.output_transcript.delta"

1481 }

1482 }

1483}

1484```

1485

1486### Example

1487

1488```json

1489{

1490 "event_id": "event_124",

1491 "type": "session.output_transcript.delta",

1492 "delta": " escuch",

1493 "elapsed_ms": 1200

1494}

1495```

1496

1497## session.output_audio.delta

1498

1499Returned when translated output audio is available. Output audio deltas are

1500200 ms frames of PCM16 audio.

1501

1502### Schema

1503

1504Schema name: `RealtimeTranslationServerEventSessionOutputAudioDelta`

1505

1506```json

1507{

1508 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema)": {

1509 "kind": "HttpDeclTypeAlias",

1510 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta",

1511 "ident": "RealtimeTranslationOutputAudioDeltaEvent",

1512 "type": {

1513 "kind": "HttpTypeObject",

1514 "members": [

1515 {

1516 "ident": "delta"

1517 },

1518 {

1519 "ident": "event_id"

1520 },

1521 {

1522 "ident": "type"

1523 },

1524 {

1525 "ident": "channels"

1526 },

1527 {

1528 "ident": "elapsed_ms"

1529 },

1530 {

1531 "ident": "format"

1532 },

1533 {

1534 "ident": "sample_rate"

1535 }

1536 ]

1537 },

1538 "docstring": "Returned when translated output audio is available. Output audio deltas are\n200 ms frames of PCM16 audio.\n",

1539 "childrenParentSchema": "object",

1540 "children": [

1541 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) delta",

1542 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) event_id",

1543 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) type",

1544 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) channels",

1545 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) elapsed_ms",

1546 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) format",

1547 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) sample_rate"

1548 ]

1549 },

1550 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) delta": {

1551 "kind": "HttpDeclProperty",

1552 "docstring": "Base64-encoded translated audio data.",

1553 "key": "delta",

1554 "optional": false,

1555 "nullable": false,

1556 "type": {

1557 "kind": "HttpTypeString"

1558 },

1559 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/delta",

1560 "deprecated": false,

1561 "schemaType": "string",

1562 "children": []

1563 },

1564 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) event_id": {

1565 "kind": "HttpDeclProperty",

1566 "docstring": "The unique ID of the server event.",

1567 "key": "event_id",

1568 "optional": false,

1569 "nullable": false,

1570 "type": {

1571 "kind": "HttpTypeString"

1572 },

1573 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/event_id",

1574 "deprecated": false,

1575 "schemaType": "string",

1576 "children": []

1577 },

1578 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) type": {

1579 "kind": "HttpDeclProperty",

1580 "docstring": "The event type, must be `session.output_audio.delta`.",

1581 "key": "type",

1582 "optional": false,

1583 "nullable": false,

1584 "type": {

1585 "kind": "HttpTypeUnion",

1586 "types": [

1587 {

1588 "kind": "HttpTypeLiteral",

1589 "literal": "session.output_audio.delta"

1590 }

1591 ],

1592 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/type"

1593 },

1594 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/type",

1595 "deprecated": false,

1596 "schemaType": "enum",

1597 "childrenParentSchema": "enum",

1598 "children": [

1599 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) type > (member) 0"

1600 ]

1601 },

1602 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) channels": {

1603 "kind": "HttpDeclProperty",

1604 "docstring": "Number of audio channels.",

1605 "key": "channels",

1606 "optional": true,

1607 "nullable": false,

1608 "default": 1,

1609 "type": {

1610 "kind": "HttpTypeNumber"

1611 },

1612 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/channels",

1613 "deprecated": false,

1614 "schemaType": "integer",

1615 "children": []

1616 },

1617 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) elapsed_ms": {

1618 "kind": "HttpDeclProperty",

1619 "docstring": "Timing metadata for stream alignment, derived from the translation frame\nwhen available. Treat `elapsed_ms` as alignment metadata, not a unique\nevent identifier.\n",

1620 "key": "elapsed_ms",

1621 "optional": true,

1622 "nullable": true,

1623 "type": {

1624 "kind": "HttpTypeNumber"

1625 },

1626 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/elapsed_ms",

1627 "deprecated": false,

1628 "schemaType": "integer",

1629 "children": []

1630 },

1631 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) format": {

1632 "kind": "HttpDeclProperty",

1633 "docstring": "Audio encoding for `delta`.",

1634 "key": "format",

1635 "optional": true,

1636 "nullable": false,

1637 "type": {

1638 "kind": "HttpTypeUnion",

1639 "types": [

1640 {

1641 "kind": "HttpTypeLiteral",

1642 "literal": "pcm16"

1643 }

1644 ],

1645 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/format"

1646 },

1647 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/format",

1648 "deprecated": false,

1649 "schemaType": "enum",

1650 "childrenParentSchema": "enum",

1651 "children": [

1652 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) format > (member) 0"

1653 ]

1654 },

1655 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) sample_rate": {

1656 "kind": "HttpDeclProperty",

1657 "docstring": "Sample rate of the audio delta.",

1658 "key": "sample_rate",

1659 "optional": true,

1660 "nullable": false,

1661 "default": 24000,

1662 "type": {

1663 "kind": "HttpTypeNumber"

1664 },

1665 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/sample_rate",

1666 "deprecated": false,

1667 "schemaType": "integer",

1668 "children": []

1669 },

1670 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) type > (member) 0": {

1671 "kind": "HttpDeclReference",

1672 "type": {

1673 "kind": "HttpTypeLiteral",

1674 "literal": "session.output_audio.delta"

1675 }

1676 },

1677 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) format > (member) 0": {

1678 "kind": "HttpDeclReference",

1679 "type": {

1680 "kind": "HttpTypeLiteral",

1681 "literal": "pcm16"

1682 }

1683 }

1684}

1685```

1686

1687### Example

1688

1689```json

1690{

1691 "event_id": "event_123",

1692 "type": "session.output_audio.delta",

1693 "delta": "Base64EncodedAudioDelta",

1694 "sample_rate": 24000,

1695 "channels": 1,

1696 "format": "pcm16",

1697 "elapsed_ms": 1200

1698}

1699```

resources/realtime/translation-server-events.md 2026-07-07 08:02 UTC to 2026-07-09 20:58 UTC

Realtime translation server events

error

Schema

Example

session.created

Schema

Example

session.updated

Schema

Example

session.closed

Schema

Example

session.input_transcript.delta

Schema

Example

session.output_transcript.delta

Schema

Example

session.output_audio.delta

Schema

Example