> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rockapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Realtime WebSocket connection

> Establish a WebSocket connection for realtime conversations.

**Note**: This is a WebSocket endpoint and must be connected to with the WebSocket protocol.

Connection URL example: `wss://api.example.com/v1/realtime?model=gpt-4o-realtime`




## OpenAPI

````yaml /ja/api-reference/openapi.json get /v1/realtime
openapi: 3.0.1
info:
  title: Rock API AI モデル API
  version: 1.0.0
  description: Rock API の OpenAI 互換 AI モデル API リファレンスです。
servers:
  - url: https://rockapi.ai
security:
  - BearerAuth: []
tags:
  - name: List models
  - name: OpenAI format (Chat)
  - name: OpenAI format (Responses)
  - name: Image generation
  - name: Image generation/OpenAI-compatible format
  - name: Image generation/Qwen
  - name: Video generation
  - name: Video generation/Sora-compatible format
  - name: Video generation/Kling format
  - name: Video generation/Jimeng format
  - name: Claude format (Messages)
  - name: Gemini format
  - name: OpenAI format (Embeddings)
  - name: Text completions
  - name: OpenAI audio
  - name: Rerank
  - name: Moderations
  - name: Realtime
  - name: Not implemented
  - name: Not implemented/Fine-tunes
  - name: Not implemented/Files
paths:
  /v1/realtime:
    get:
      tags:
        - Realtime
      summary: Realtime WebSocket connection
      description: >
        Establish a WebSocket connection for realtime conversations.


        **Note**: This is a WebSocket endpoint and must be connected to with the
        WebSocket protocol.


        Connection URL example:
        `wss://api.example.com/v1/realtime?model=gpt-4o-realtime`
      operationId: createRealtimeSession
      parameters:
        - name: model
          in: query
          description: Model to use
          required: false
          schema:
            type: string
            example: gpt-4o-realtime-preview
      responses:
        '101':
          description: WebSocket protocol switch
          headers: {}
        '400':
          description: Request error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
      deprecated: false
      security:
        - BearerAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
              description: Error message
            type:
              type: string
              description: Error type
            param:
              type: string
              description: Related parameter
              nullable: true
            code:
              type: string
              description: Error code
              nullable: true
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: |
        Authenticate with a Bearer Token.
        Format: `Authorization: Bearer sk-xxxxxx`

````