---
title: "Get realtime session"
method: GET
path: "/v1/realtime_sessions/{id}"
tags: ["Realtime Sessions"]
---

# Get realtime session

`GET /v1/realtime_sessions/{id}`

Get the status of a realtime session. This endpoint uses the same ID that the avatar conversation endpoints later expose as the conversation ID.

## Path parameters

- `id` string, uuid, required

## Headers

- `X-Runway-Version` '2024-11-06', required

## Response `200`

Success

- union
  - object — A session that is being provisioned.
    - `id` string, uuid, required — The realtime session ID. This same value is later used as the conversation ID in the avatar conversation endpoints.
    - `createdAt` string, date-time, required — When the session was created.
    - `status` 'NOT_READY', required
    - `queued` boolean — When true, the session is waiting in a queue for available capacity. When false or absent, the session is actively being provisioned.
  - object — A session that is ready to connect.
    - `id` string, uuid, required — The realtime session ID. This same value is later used as the conversation ID in the avatar conversation endpoints.
    - `createdAt` string, date-time, required — When the session was created.
    - `status` 'READY', required
    - `expiresAt` string, date-time, required — When the session credentials expire.
    - `sessionKey` string, required — Session key for authenticating the /consume endpoint. Use as Bearer token.
  - object — A session with an active WebRTC connection.
    - `id` string, uuid, required — The realtime session ID. This same value is later used as the conversation ID in the avatar conversation endpoints.
    - `createdAt` string, date-time, required — When the session was created.
    - `status` 'RUNNING', required
  - object — A session that ended normally.
    - `id` string, uuid, required — The realtime session ID. This same value is later used as the conversation ID in the avatar conversation endpoints.
    - `createdAt` string, date-time, required — When the session was created.
    - `status` 'COMPLETED', required
    - `duration` integer, required — The session duration in seconds.
  - object — A session that encountered an error.
    - `id` string, uuid, required — The realtime session ID. This same value is later used as the conversation ID in the avatar conversation endpoints.
    - `createdAt` string, date-time, required — When the session was created.
    - `status` 'FAILED', required
    - `failure` string, required — A human-readable error message. This value is not stable and should not be matched against programmatically.
    - `failureCode` string, required — A stable, machine-readable error code. See https://docs.dev.runwayml.com/errors/task-failures/ for more information.
  - object — A session that was explicitly cancelled.
    - `id` string, uuid, required — The realtime session ID. This same value is later used as the conversation ID in the avatar conversation endpoints.
    - `createdAt` string, date-time, required — When the session was created.
    - `status` 'CANCELLED', required

---

[API](https://skmtc.net/runwayml/apis/runwayml-api.md) · [All operations](https://skmtc.net/runwayml/apis/runwayml-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/runwayml/runwayml-api/revisions/3f3a4647d82f/schema)