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

# Get Realtime Transcription

> Get the status of a realtime transcription session. The response has the same shape as the create response, without `streamToken`.

A session that ends while no WebSocket connection is open cannot send `session.ended`. Use this endpoint to read its `endReason`.




## OpenAPI

````yaml /openapi.yaml get /v1/external/realtime-transcriptions/{id}
openapi: 3.1.0
info:
  title: Tiro API
  description: AI-powered note-taking and voice file processing API
  version: 1.0.0
  contact:
    name: Tiro Support
    email: support@tiro.ooo
    url: https://tiro.ooo
servers:
  - url: https://api.tiro.ooo
    description: Production server
security:
  - BearerAuth: []
tags:
  - name: Workspace
    description: >
      List the workspaces an API key can reach. Workspace-scoped endpoints take
      a

      `{workspaceGuid}` path segment; get it from `GET /v1/external/workspaces`.
  - name: Note
    description: Operations for managing notes and their paragraphs
  - name: Note Share Link
    description: Manage share links for notes
  - name: Note Summary
    description: Operations for retrieving note summaries
  - name: Note Document
    description: Template-based document generation from notes
  - name: Note Document Template
    description: Operations for managing note document templates
  - name: Folder
    description: Operations for retrieving folders
  - name: Voice File
    description: Operations for voice file processing
  - name: Realtime Transcription
    description: >
      Create, get, list, and end realtime transcription sessions. Audio and
      results flow over the

      WebSocket at `wsUrl`, documented in [WebSocket
      protocol](/en/developers/realtime-transcription/protocol).

      Available to Enterprise plan customers on request.
  - name: Word Memory
    description: >
      Manage word memories to improve voice transcription accuracy. Register
      important terms like company names, people's names, and product names so
      Tiro recognizes them precisely during recording. Each term has an `entry`
      and an optional `subEntry` (an alternate spelling or notation). Personal
      (User), workspace-shared (Workspace), and organization-shared
      (Organization) word memories are managed separately, and each scope
      supports bulk create/update/delete (up to 1000 items per request).
  - name: Wiki
    description: |
      Access workspace wikis — unified knowledge graphs built from notes.
      Requires a workspace with wiki plan and activation enabled.
  - name: Organization
    description: >
      Endpoints for organization API keys. An organization key is issued by an

      organization admin, carries fixed scopes chosen at issuance, and can reach

      the notes in every workspace that belongs to the organization. Built for

      server-to-server integrations such as CRM sync — receive `note.ended`
      webhook

      events, generate documents for notes, and reconcile with the organization

      notes list.
  - name: Organization Management
    description: Operations for the authenticated user's organization.
paths:
  /v1/external/realtime-transcriptions/{id}:
    get:
      tags:
        - Realtime Transcription
      summary: Get Realtime Transcription
      description: >
        Get the status of a realtime transcription session. The response has the
        same shape as the create response, without `streamToken`.


        A session that ends while no WebSocket connection is open cannot send
        `session.ended`. Use this endpoint to read its `endReason`.
      operationId: getRealtimeTranscription
      parameters:
        - name: id
          in: path
          required: true
          description: The session `id` returned from Create Realtime Transcription.
          schema:
            type: string
          example: Rt7Yq2PbX9cDk
      responses:
        '200':
          description: Session details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealtimeTranscription'
        '401':
          description: The API key is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >
            `403013 forbidden` (`insufficient_scope`) when the key lacks
            `realtime_transcription:read`.


            `403024 forbidden` (`workspace_bound_key_required`) for an account
            API key not bound to a workspace or an organization API key.


            `403025 forbidden` (`workspace_access_denied`) when the account API
            key owner is not a member of the key's workspace.


            This endpoint works even when the Realtime Transcription API is
            turned off for the workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >
            `404050 not_found` (`realtime_transcription_not_found`) when the
            session does not exist or does not belong to the key's workspace.


            `404039 not_found` without `detail.reason` when the key's workspace
            was deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    RealtimeTranscription:
      type: object
      description: >
        A realtime transcription session. Results are delivered only over the
        WebSocket at `wsUrl`, not through this resource.

        See [WebSocket
        protocol](/en/developers/realtime-transcription/protocol).
      required:
        - id
        - workspaceGuid
        - status
        - wsUrl
        - maxDurationMs
        - audioDurationMs
        - createdAt
      properties:
        id:
          type: string
          description: Session ID.
          example: Rt7Yq2PbX9cDk
        workspaceGuid:
          type: string
          description: >-
            Workspace the session belongs to. Concurrent sessions are counted
            per workspace.
          example: Wk8sQ2mLx1aB7
        apiKeyId:
          type: string
          nullable: true
          description: >-
            Public ID of the API key that created the session, matching
            `apiKeyId` from `GET /v1/external/auth/me`. `null` only when Tiro
            can no longer find that key.
          example: tk_8f2a91c0d3e4
        status:
          type: string
          enum:
            - OPEN
            - ENDED
          description: >
            - `OPEN`: Tiro accepts audio. You can connect and reconnect. The
            session holds a concurrent slot

            - `ENDED`: The session is over. You cannot reconnect


            New values can appear. Treat an unknown value as not `ENDED`.
          example: OPEN
        endReason:
          type: string
          nullable: true
          enum:
            - CLIENT_REQUESTED
            - IDLE_TIMEOUT
            - MAX_DURATION
            - INTERNAL_ERROR
          description: >
            Why the session ended. `null` while `OPEN`.

            - `CLIENT_REQUESTED`: WebSocket `session.end` or End Realtime
            Transcription

            - `IDLE_TIMEOUT`: No audio for 15 minutes

            - `MAX_DURATION`: 3 hours since the first connection

            - `INTERNAL_ERROR`: Tiro could not continue the session


            New values can appear. Treat an unknown value as a normal end.
          example: null
        wsUrl:
          type: string
          description: >-
            WebSocket URL to connect to. Use it as returned. Do not build or
            hard-code the host or path.
          example: >-
            wss://api.tiro.ooo/v1/external/realtime-transcriptions/Rt7Yq2PbX9cDk/stream
        streamToken:
          type: string
          description: >
            Token for the WebSocket `Authorization: Bearer` header. Present only
            in the Create Realtime Transcription response.

            Opaque, up to 512 characters. Valid for this session while it is
            `OPEN`.
          example: rtt_5Hq3...
        maxDurationMs:
          type: integer
          format: int64
          description: >-
            Maximum session length, counted from the first connection. Currently
            10,800,000 (3 hours).
          example: 10800000
        audioDurationMs:
          type: integer
          format: int64
          description: >-
            Audio length Tiro has received so far, including connections that
            already closed.
          example: 0
        transcriptionLocale:
          type: string
          nullable: true
          description: >-
            Transcription locale applied to the session. `null` means auto
            detection.
          example: ko_KR
        translationLocale:
          type: string
          nullable: true
          description: Translation locale. `null` means no translation.
          example: en_US
        createdAt:
          type: string
          format: date-time
          description: When the session was created.
          example: '2026-11-05T09:00:00Z'
        endedAt:
          type: string
          format: date-time
          nullable: true
          description: When the session ended. `null` while `OPEN`.
          example: null
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - errorType
            - message
          properties:
            code:
              type: integer
              description: >
                6-digit error code in `AAABBB` form: first 3 digits match the
                HTTP status,

                last 3 digits are a per-status serial (e.g. `404018`). Use only
                when you need

                to distinguish specific error cases within the same HTTP status
                — values may be

                added or renumbered across releases. For general client
                branching, prefer `errorType`.
              example: 404018
            errorType:
              type: string
              description: >
                Stable, coarse-grained error category. Recommended default for
                client-side

                branching: the value-to-status mapping is part of the API
                contract and will not

                change without a breaking-change notice. Typical use:
                  - `unauthorized` → trigger re-authentication
                  - `forbidden` → surface a permission error to the user
                  - `not_found` → treat as missing resource
                  - `too_many_requests` → back off and retry
                  - `internal_error` → retry with exponential backoff
              enum:
                - bad_request
                - unauthorized
                - forbidden
                - not_found
                - not_acceptable
                - conflict
                - payload_too_large
                - unprocessable_entity
                - too_many_requests
                - internal_error
              example: not_found
            message:
              type: string
              description: >-
                Human-readable error message. Not stable; do not use for
                branching.
              example: 'No team found for user #217'
            detail:
              description: >-
                Additional error details. Authorization failures may include a
                reason and required scopes.
              oneOf:
                - type: string
                  nullable: true
                - type: object
                  additionalProperties: true
                  properties:
                    reason:
                      type: string
                      example: insufficient_scope
                    required:
                      type: array
                      items:
                        type: string
                      example:
                        - folder:read
              example: null
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        API key in format `{id}.{secret}`.


        The notes an endpoint returns depend on the key type. A **user key**
        reaches the

        notes that user can see in the app, including notes in their own private
        folders.

        A **system key** (workspace or organization, no user identity) reaches
        only notes

        that sit in a folder shared with all workspace members. Notes in a
        private folder,

        in a folder shared with only some members, or in no folder at all fall
        outside a

        system key's read scope, and scopes do not widen that boundary.


        List and search endpoints drop out-of-scope notes from the response
        without an

        error. Single-note reads and their sub-resources return `404`, the same
        response

        as a deleted note. See [What notes a system key
        reads](https://docs.tiro.ooo/en/developers/fundamentals/system-key-note-scope).

````

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