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

# Get realtime endpoint

> Where to open the `/v1/realtime` WebSocket for a streaming model. Connect to `websocket_url` exactly as returned, with the same API key. For AirCaps Live 1 the answer is the server that gives this client the lowest latency among those that can take a session right now: look it up once before every session, and do not hard-code or cache it across sessions. See the [AirCaps Live 1 guide](/guides/live-1#1-get-the-websocket-address).



## OpenAPI

````yaml GET /v1/realtime/endpoint
openapi: 3.1.0
info:
  title: AirCaps AI API
  version: 1.0.0
  description: >-
    Speech-to-text: A5S Async v1 (REST; English, Spanish, French, German,
    Portuguese, Hindi, Japanese, Korean and Chinese). Real-time speech-to-text
    for voice agents: AirCaps Live 1 (WebSocket, English). Live streaming: A5S
    Streaming v1 (WebSocket, early access for select organizations). Speaker
    identification: AirCaps Speaker ID-v1 (REST, synchronous). Speaker
    diarization: AirCaps Diarization-v1 (REST, enabled on request).
  contact:
    name: AirCaps AI
    url: https://aircaps.ai/contact
servers:
  - url: https://api.aircaps.com
security:
  - bearerAuth: []
tags:
  - name: Transcripts
  - name: Realtime
  - name: Speakers
  - name: Diarizations
  - name: Files
  - name: Account
externalDocs:
  description: AirCaps AI API docs
  url: https://aircaps.ai/docs
paths:
  /v1/realtime/endpoint:
    get:
      tags:
        - Realtime
      summary: Get realtime endpoint
      description: >-
        Where to open the `/v1/realtime` WebSocket for a streaming model.
        Connect to `websocket_url` exactly as returned, with the same API key.
        For AirCaps Live 1 the answer is the server that gives this client the
        lowest latency among those that can take a session right now: look it up
        once before every session, and do not hard-code or cache it across
        sessions. See the [AirCaps Live 1
        guide](/guides/live-1#1-get-the-websocket-address).
      operationId: getRealtimeEndpoint
      parameters:
        - name: model
          in: query
          required: true
          description: 'The streaming model: `aircaps-live-1` or `a5s-streaming-v1`.'
          schema:
            type: string
            enum:
              - aircaps-live-1
              - a5s-streaming-v1
      responses:
        '200':
          description: The address to connect to.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealtimeEndpoint'
              example:
                websocket_url: wss://rt1.aircaps.ai/v1/realtime
                model: aircaps-live-1
        '400':
          description: >-
            `model` is missing, unknown, or left out of an account limited to
            specific models. Codes: `unsupported_model`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: invalid_request_error
                  code: unsupported_model
                  message: model 'aircaps-live' is not available for streaming
                  param: null
                  request_id: req_01k6z3m4q8w7e5r2t1y0u9i8o7
        '401':
          description: 'Missing or invalid API key. Codes: `unauthorized`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: authentication_error
                  code: unauthorized
                  message: invalid API key
                  param: null
                  request_id: req_01k6z3m4q8w7e5r2t1y0u9i8o7
        '403':
          description: >-
            The account may not use the model. `model_access_denied`: A5S
            Streaming v1 without early access. `model_unavailable`: a model that
            is not offered in the cloud. Codes: `account_disabled`,
            `model_access_denied`, `model_unavailable`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: permission_error
                  code: model_access_denied
                  message: >-
                    A5S Streaming v1 is in early access for select
                    organizations, and your organization does not have access
                    yet. To request access, talk to sales at
                    https://aircaps.ai/contact.
                  param: null
                  request_id: req_01k6z3m4q8w7e5r2t1y0u9i8o7
        '500':
          description: >-
            Server error. Safe to retry (use the same Idempotency-Key). Codes:
            `internal_error`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: api_error
                  code: internal_error
                  message: internal error
                  param: null
                  request_id: req_01k6z3m4q8w7e5r2t1y0u9i8o7
        '503':
          description: >-
            Temporarily unavailable. Retry after the Retry-After interval.
            Codes: `service_unavailable`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: api_error
                  code: service_unavailable
                  message: temporarily unavailable; please retry
                  param: null
                  request_id: req_01k6z3m4q8w7e5r2t1y0u9i8o7
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
components:
  schemas:
    RealtimeEndpoint:
      type: object
      required:
        - websocket_url
        - model
      properties:
        websocket_url:
          type: string
          description: Open this address, with the same `Authorization` header.
          example: wss://rt1.aircaps.ai/v1/realtime
        model:
          type: string
          description: The model the address is for.
          example: aircaps-live-1
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - api_error
            code:
              type: string
              description: Machine-readable code; see [Errors](/errors).
            message:
              type: string
            param:
              type:
                - string
                - 'null'
              description: The request field at fault, if any.
            request_id:
              type:
                - string
                - 'null'
              description: >-
                Also in the `x-request-id` header. Include it when you contact
                support (https://console.aircaps.ai/support). `null` on 502/504
                from the edge.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `Authorization: Bearer aircaps_sk_...`'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.