Skip to Content

Get Live Session

Retrieve the full details of a specific live translation session.

GET/v2/live/sessions/:id

Path Parameters

Path Parameters

NameTypeRequiredDescription
idstringrequired
The unique identifier of the live session.

Response

Returns 200 OK with the full session object.

sessionIdstring

Unique session identifier.

statusstring

Current external session status: "active", "finalizing", or "ended". "ended" additionally surfaces "error" when the session failed.

sourceTypestring

The source type configured for this session (RTMP_PUSH, SRT_PUSH, or HLS_PULL).

outputTypestring

The output type configured for this session (HLS, RTMP, or SRT).

pictureInPictureboolean

Whether server-side picture-in-picture compositing is enabled for this session.

languagestring

Configured target sign language for the session (e.g. "BSL", "ASL").

signerstring

Configured signer for the session output (e.g. "RAE", "MAX", "JAY").

hlsSourceUrlstring

The HLS manifest URL Signapse is pulling from. Present when sourceType is HLS_PULL.

rtmpEndpointsstring[]

RTMP ingest endpoints. Present when sourceType is RTMP_PUSH.

relayActiveboolean

True when the RTMP relay is in front of MediaLive. False when the customer pushes directly.

outputManifestUrlstring

HLS manifest URL (legacy — byte-for-byte equal to manifests.hls). Present when outputType is HLS.

rtmpOutputUrlstring

Configured RTMP destination URL. Present when outputType is RTMP.

rtmpOutputStreamKeystring

Configured stream key for the RTMP output. Present when outputType is RTMP.

manifests.hlsstring

HLS playlist URL (.m3u8). Present when outputType is HLS.

manifests.dashstring

DASH manifest URL (.mpd), live profile, served as application/dash+xml. Present when outputType is HLS.

manifests.pipstring

Composite HLS playlist URL (.m3u8) carrying the source video with the signer overlaid. Present only when pictureInPicture is true and outputType is HLS.

startedAtstring

ISO 8601 timestamp when the session began processing.

stoppedAtstring

ISO 8601 timestamp when the session stopped. Omitted while the session is still active.

errorstring

Error message when status is "ended" due to failure. Omitted otherwise.

Request
curl -X GET "https://ai.api.production.signapsesolutions.com/v2/live/sessions/ls_abc123def456" \
  -H "X-API-KEY: YOUR_API_KEY"
Response
{
  "sessionId": "ls_abc123def456",
  "status": "active",
  "sourceType": "RTMP_PUSH",
  "outputType": "HLS",
  "pictureInPicture": false,
  "language": "BSL",
  "signer": "RAE",
  "rtmpEndpoints": [
    "rtmp://ingest.signapsesolutions.com/live/ls_abc123def456"
  ],
  "relayActive": true,
  "outputManifestUrl": "https://output.signapsesolutions.com/live/ls_abc123def456/index.m3u8",
  "manifests": {
    "hls":  "https://output.signapsesolutions.com/live/ls_abc123def456/index.m3u8",
    "dash": "https://output.signapsesolutions.com/live/ls_abc123def456/manifest.mpd"
  },
  "startedAt": "2026-03-11T10:00:15Z"
}
Last updated on
Question? Give us feedback
support@signapse.ai