livekit-api 1.1.1__tar.gz → 1.2.1__tar.gz

livekit_api-1.2.1/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.5
+Name: livekit-api
+Version: 1.2.1
+Summary: Python Server API for LiveKit
+Project-URL: Documentation, https://docs.livekit.io
+Project-URL: Website, https://livekit.io/
+Project-URL: Source, https://github.com/livekit/python-sdks/
+Author-email: LiveKit <support@livekit.io>
+License-Expression: Apache-2.0
+Keywords: audio,livekit,realtime,video,webrtc
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9.0
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: livekit-protocol<2.0.0,>=1.1.25
+Requires-Dist: protobuf>=4
+Requires-Dist: pyjwt>=2.0.0
+Requires-Dist: types-protobuf>=4
+Description-Content-Type: text/markdown
+
+# LiveKit Server APIs
+
+Access LiveKit server APIs and generate access tokens.
+
+See https://docs.livekit.io/reference/server/server-apis for more information.
+
+## Authentication
+
+Every request to the server APIs is authenticated. `LiveKitAPI` supports two modes:
+
+- **API key & secret** — recommended for backend use. The SDK signs a short-lived token per request from your key and secret. Keep your API secret on the server; never ship it to a client.
+- **Access token** — for client-side use where the API secret must not be exposed. Pass a pre-signed [access token](https://docs.livekit.io/home/get-started/authentication/) that already carries the grants for the operations you'll perform; the SDK sends it verbatim.
+
+```python
+from livekit import api
+
+# API key & secret: set LIVEKIT_URL, LIVEKIT_API_KEY, and LIVEKIT_API_SECRET,
+# then construct with no arguments...
+lkapi = api.LiveKitAPI()
+
+# ...or pass any of them explicitly to override the corresponding env var:
+lkapi = api.LiveKitAPI("https://my.livekit.host", api_key="api-key", api_secret="api-secret")
+
+# Pre-signed access token (client-side): with LIVEKIT_URL set, pass just the token:
+lkapi = api.LiveKitAPI.with_token("a-pre-signed-token")
+```
+
+The url and credentials fall back to the `LIVEKIT_URL`, `LIVEKIT_API_KEY`, `LIVEKIT_API_SECRET`, and `LIVEKIT_TOKEN` environment variables. Values you pass explicitly take precedence; the environment variables are used only as a fallback for arguments you omit — an ambient `LIVEKIT_TOKEN`, for example, won't override an explicitly-provided API key and secret.
+

livekit_api-1.2.1/README.md

@@ -0,0 +1,29 @@
+# LiveKit Server APIs
+
+Access LiveKit server APIs and generate access tokens.
+
+See https://docs.livekit.io/reference/server/server-apis for more information.
+
+## Authentication
+
+Every request to the server APIs is authenticated. `LiveKitAPI` supports two modes:
+
+- **API key & secret** — recommended for backend use. The SDK signs a short-lived token per request from your key and secret. Keep your API secret on the server; never ship it to a client.
+- **Access token** — for client-side use where the API secret must not be exposed. Pass a pre-signed [access token](https://docs.livekit.io/home/get-started/authentication/) that already carries the grants for the operations you'll perform; the SDK sends it verbatim.
+
+```python
+from livekit import api
+
+# API key & secret: set LIVEKIT_URL, LIVEKIT_API_KEY, and LIVEKIT_API_SECRET,
+# then construct with no arguments...
+lkapi = api.LiveKitAPI()
+
+# ...or pass any of them explicitly to override the corresponding env var:
+lkapi = api.LiveKitAPI("https://my.livekit.host", api_key="api-key", api_secret="api-secret")
+
+# Pre-signed access token (client-side): with LIVEKIT_URL set, pass just the token:
+lkapi = api.LiveKitAPI.with_token("a-pre-signed-token")
+```
+
+The url and credentials fall back to the `LIVEKIT_URL`, `LIVEKIT_API_KEY`, `LIVEKIT_API_SECRET`, and `LIVEKIT_TOKEN` environment variables. Values you pass explicitly take precedence; the environment variables are used only as a fallback for arguments you omit — an ambient `LIVEKIT_TOKEN`, for example, won't override an explicitly-provided API key and secret.
+

{livekit_api-1.1.1 → livekit_api-1.2.1}/livekit/api/__init__.py

@@ -36,7 +36,13 @@ from livekit.protocol.sip import *
 from livekit.protocol.connector_whatsapp import *
 from livekit.protocol.connector_twilio import *
 
-from .twirp_client import TwirpError, TwirpErrorCode
+from .twirp_client import (
+    ServerError,
+    ServerErrorCode,
+    SipCallError,
+    TwirpError,
+    TwirpErrorCode,
+)
 from .livekit_api import LiveKitAPI
 from .access_token import (
     InferenceGrants,
@@ -64,6 +70,9 @@ __all__ = [
     "AccessToken",
     "TokenVerifier",
     "WebhookReceiver",
+    "ServerError",
+    "ServerErrorCode",
     "TwirpError",
     "TwirpErrorCode",
+    "SipCallError",
 ]

livekit_api-1.2.1/livekit/api/_dial_timeout.py

@@ -0,0 +1,51 @@
+from __future__ import annotations
+
+from typing import Optional, Union
+
+from livekit.protocol.sip import CreateSIPParticipantRequest, TransferSIPParticipantRequest
+
+# Requests that carry ringing_timeout and share the phone-dialing timeout behavior.
+DialRequest = Union[
+    CreateSIPParticipantRequest,
+    TransferSIPParticipantRequest,
+]
+"""@private"""
+
+# Ring window (seconds) assumed when a request doesn't set ringing_timeout;
+# matches the server default. A dialing request must outlast it.
+DEFAULT_RINGING_TIMEOUT = 30.0
+"""@private"""
+
+# A dialing request must outlast the ringing window, or it would abort before
+# the call can be answered. Keep the request timeout at least this many seconds
+# above the ringing timeout.
+RINGING_TIMEOUT_MARGIN = 2.0
+"""@private"""
+
+
+def pin_ringing_timeout(request: DialRequest) -> None:
+    """Set the ring window explicitly on a dialing request when the caller left it
+    unset, so the derived request timeout doesn't depend on the server's default
+    (which could change out from under us).
+
+    @private
+    """
+    if not request.HasField("ringing_timeout"):
+        request.ringing_timeout.seconds = int(DEFAULT_RINGING_TIMEOUT)
+
+
+def dial_timeout(user_timeout: Optional[float], request: DialRequest) -> float:
+    """Request timeout (seconds) for a phone-dialing call: the ring window plus a
+    margin, so the request doesn't abort before the call can be answered. The
+    ring window is the request's ringing_timeout when set, else
+    DEFAULT_RINGING_TIMEOUT. A longer user_timeout is honored; a shorter one is
+    raised to the floor.
+
+    @private
+    """
+    if request.HasField("ringing_timeout"):
+        ring: float = request.ringing_timeout.seconds
+    else:
+        ring = DEFAULT_RINGING_TIMEOUT
+    floor = ring + RINGING_TIMEOUT_MARGIN
+    return max(user_timeout if user_timeout else floor, floor)

livekit_api-1.2.1/livekit/api/_failover.py

@@ -0,0 +1,162 @@
+# Copyright 2026 LiveKit, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Region failover for the Twirp API clients.
+
+On a retryable failure (any transport error or HTTP 5xx) the client discovers
+alternative LiveKit Cloud regions via ``/settings/regions`` and replays the
+request against the next region, with exponential backoff. 4xx responses are
+returned immediately.
+"""
+
+from __future__ import annotations
+
+import time
+from dataclasses import dataclass
+from typing import Dict, List, Optional
+from urllib.parse import urlparse
+
+import aiohttp
+
+FAILOVER_MAX_ATTEMPTS = 3
+FAILOVER_BACKOFF_BASE = 0.2  # seconds
+# Below this per-request timeout (seconds) a retry is unlikely to help and many
+# clients would retry in lockstep across regions, so a short request gets a
+# single attempt (thundering-herd guard).
+MIN_FAILOVER_TIMEOUT = 5.0
+
+
+def failover_attempts(
+    enabled: bool,
+    host: Optional[str],
+    force: bool = False,
+    timeout: Optional[float] = None,
+) -> int:
+    """Total request attempts for a host; 1 means no failover. Failover only
+    engages when enabled, the host is a LiveKit Cloud domain, and the request
+    timeout is long enough to retry. ``force`` bypasses the cloud-host check and
+    is for internal testing only.
+    """
+    if not (enabled and (force or (host is not None and is_cloud(host)))):
+        return 1
+    if timeout is not None and 0 < timeout < MIN_FAILOVER_TIMEOUT:
+        return 1
+    return FAILOVER_MAX_ATTEMPTS
+
+
+def is_cloud(host: str) -> bool:
+    # Failover only engages for LiveKit Cloud project domains.
+    return host.endswith(".livekit.cloud")
+
+
+def to_http(url: str) -> str:
+    """Normalizes a region URL to an http(s) scheme (ws -> http, wss -> https)."""
+    if url.startswith("ws"):
+        return "http" + url[2:]
+    return url
+
+
+def origin_of(url: str) -> str:
+    """Returns the scheme://host[:port] origin of a URL, dropping any path."""
+    parsed = urlparse(url)
+    return f"{parsed.scheme}://{parsed.netloc}"
+
+
+def host_key(url: str) -> str:
+    """A stable key identifying a host (including port) for dedup across attempts."""
+    return urlparse(url).netloc.lower()
+
+
+def pick_next(region_origins: List[str], attempted: set[str]) -> Optional[str]:
+    """Returns the first region origin whose host has not yet been attempted."""
+    for origin in region_origins:
+        if host_key(origin) not in attempted:
+            return origin
+    return None
+
+
+@dataclass
+class _CacheEntry:
+    origins: List[str]
+    fetched_at: float
+    ttl: float
+
+
+class RegionCache:
+    """Process-wide cache of the LiveKit Cloud region list, keyed by host."""
+
+    def __init__(self) -> None:
+        self._entries: Dict[str, _CacheEntry] = {}
+
+    async def region_origins(
+        self,
+        session: aiohttp.ClientSession,
+        origin: str,
+        headers: Dict[str, str],
+    ) -> List[str]:
+        """Returns alternative region origins for ``origin``, fetching
+        ``/settings/regions`` if the cache is stale. Best-effort: on a fetch
+        failure it serves a stale cached list when available, otherwise an empty
+        list. Forwards ``headers`` so a valid token — and any test directives —
+        reach the discovery endpoint."""
+        key = host_key(origin)
+        entry = self._entries.get(key)
+        if entry is not None and (time.monotonic() - entry.fetched_at) < entry.ttl:
+            return entry.origins
+
+        try:
+            origins, ttl = await self._fetch(session, origin, headers)
+        except Exception:
+            return entry.origins if entry is not None else []
+
+        # A zero TTL (e.g. Cache-Control: max-age=0) means "do not cache".
+        if ttl > 0:
+            self._entries[key] = _CacheEntry(origins, time.monotonic(), ttl)
+        return origins
+
+    async def _fetch(
+        self,
+        session: aiohttp.ClientSession,
+        origin: str,
+        headers: Dict[str, str],
+    ) -> tuple[List[str], float]:
+        fetch_headers = {
+            k: v for k, v in headers.items() if k.lower() not in ("content-type", "content-length")
+        }
+        # Short timeout so a slow/unreachable discovery endpoint doesn't stall
+        # the failover path.
+        async with session.get(
+            f"{origin}/settings/regions",
+            headers=fetch_headers,
+            timeout=aiohttp.ClientTimeout(total=2),
+        ) as resp:
+            if resp.status != 200:
+                raise RuntimeError(f"region discovery failed: {resp.status}")
+            ttl = _parse_max_age(resp.headers.get("Cache-Control"))
+            body = await resp.json()
+        origins = [origin_of(to_http(r["url"])) for r in body.get("regions", []) if r.get("url")]
+        return origins, ttl
+
+
+def _parse_max_age(cache_control: Optional[str]) -> float:
+    if not cache_control:
+        return 0.0
+    for directive in cache_control.split(","):
+        directive = directive.strip().lower()
+        if directive.startswith("max-age="):
+            try:
+                return float(int(directive[len("max-age=") :]))
+            except ValueError:
+                return 0.0
+    return 0.0

livekit_api-1.2.1/livekit/api/_service.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+import aiohttp
+from abc import ABC
+from .twirp_client import TwirpClient
+from .access_token import AccessToken, VideoGrants, SIPGrants
+
+AUTHORIZATION = "authorization"
+
+
+class Service(ABC):
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        host: str,
+        api_key: str,
+        api_secret: str,
+        failover: bool = True,
+    ):
+        self._client = TwirpClient(session, host, "livekit", failover=failover)
+        self.api_key = api_key
+        self.api_secret = api_secret
+        # A pre-signed token set by LiveKitAPI for token auth; sent verbatim,
+        # skipping per-call signing. Per-service constructors stay key/secret-only.
+        self._token: str | None = None
+
+    def _auth_header(
+        self, grants: VideoGrants | None, sip: SIPGrants | None = None
+    ) -> dict[str, str]:
+        # A pre-signed token is sent verbatim; the caller is responsible for its grants.
+        if self._token:
+            return {AUTHORIZATION: "Bearer {}".format(self._token)}
+
+        tok = AccessToken(self.api_key, self.api_secret)
+        if grants:
+            tok.with_grants(grants)
+        if sip is not None:
+            tok.with_sip_grants(sip)
+
+        token = tok.to_jwt()
+        return {AUTHORIZATION: "Bearer {}".format(token)}

{livekit_api-1.1.1 → livekit_api-1.2.1}/livekit/api/access_token.py

@@ -233,14 +233,26 @@ class TokenVerifier:
         if verify_signature and (not self.api_key or not self.api_secret):
             raise ValueError("api_key and api_secret must be set")
 
-        claims = jwt.decode(
-            token,
-            key=self.api_secret or "",
-            issuer=self.api_key or "",
-            algorithms=["HS256"],
-            leeway=self._leeway.total_seconds(),
-            options={"verify_signature": verify_signature},
-        )
+        # First-party minters always set exp. Without this, a hand-rolled token
+        # with a valid signature and no exp verifies forever (livekit/protocol#1706).
+        if verify_signature:
+            claims = jwt.decode(
+                token,
+                key=self.api_secret or "",
+                issuer=self.api_key or "",
+                algorithms=["HS256"],
+                leeway=self._leeway.total_seconds(),
+                options={"verify_signature": True, "require": ["exp"]},
+            )
+        else:
+            claims = jwt.decode(
+                token,
+                key=self.api_secret or "",
+                issuer=self.api_key or "",
+                algorithms=["HS256"],
+                leeway=self._leeway.total_seconds(),
+                options={"verify_signature": False},
+            )
         video_dict = claims.get("video", dict())
         video_dict = {camel_to_snake(k): v for k, v in video_dict.items()}
         video_dict = {k: v for k, v in video_dict.items() if k in VideoGrants.__dataclass_fields__}
@@ -271,9 +283,10 @@ class TokenVerifier:
 
         if claims.get("roomPreset"):
             grant_claims.room_preset = claims.get("roomPreset")
-        if claims.get("roomConfig"):
+        room_config = claims.get("roomConfig")
+        if room_config:
             grant_claims.room_config = ParseDict(
-                claims.get("roomConfig"),
+                room_config,
                 RoomConfiguration(),
                 ignore_unknown_fields=True,
             )

{livekit_api-1.1.1 → livekit_api-1.2.1}/livekit/api/agent_dispatch_service.py

@@ -26,8 +26,15 @@ class AgentDispatchService(Service):
     ```
     """
 
-    def __init__(self, session: aiohttp.ClientSession, url: str, api_key: str, api_secret: str):
-        super().__init__(session, url, api_key, api_secret)
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        url: str,
+        api_key: str,
+        api_secret: str,
+        failover: bool = True,
+    ):
+        super().__init__(session, url, api_key, api_secret, failover=failover)
 
     async def create_dispatch(self, req: CreateAgentDispatchRequest) -> AgentDispatch:
         """Create an explicit dispatch for an agent to join a room.

{livekit_api-1.1.1 → livekit_api-1.2.1}/livekit/api/connector_service.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import aiohttp
+from typing import Optional
 
 from livekit.protocol.connector_whatsapp import (
     DialWhatsAppCallRequest,
@@ -17,6 +18,7 @@ from livekit.protocol.connector_twilio import (
     ConnectTwilioCallResponse,
 )
 from ._service import Service
+from ._dial_timeout import DEFAULT_RINGING_TIMEOUT
 from .access_token import VideoGrants
 
 SVC = "Connector"
@@ -35,8 +37,15 @@ class ConnectorService(Service):
     ```
     """
 
-    def __init__(self, session: aiohttp.ClientSession, url: str, api_key: str, api_secret: str):
-        super().__init__(session, url, api_key, api_secret)
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        url: str,
+        api_key: str,
+        api_secret: str,
+        failover: bool = True,
+    ):
+        super().__init__(session, url, api_key, api_secret, failover=failover)
 
     async def dial_whatsapp_call(
         self, request: DialWhatsAppCallRequest
@@ -99,23 +108,41 @@ class ConnectorService(Service):
         )
 
     async def accept_whatsapp_call(
-        self, request: AcceptWhatsAppCallRequest
+        self,
+        request: AcceptWhatsAppCallRequest,
+        *,
+        timeout: Optional[float] = None,
     ) -> AcceptWhatsAppCallResponse:
         """
         Accept an inbound WhatsApp call
 
         Args:
             request: AcceptWhatsAppCallRequest containing call parameters and SDP
+            timeout: Optional request timeout in seconds. When the request waits
+                for the inbound party to join (wait_until_answered), it defaults
+                to the standard ring window.
 
         Returns:
             AcceptWhatsAppCallResponse with the room name
         """
+        client_timeout: Optional[aiohttp.ClientTimeout] = None
+        if request.wait_until_answered:
+            # Waiting for the inbound party to join can block, so default the
+            # request timeout to the standard ring window; the caller overrides
+            # via timeout.
+            client_timeout = aiohttp.ClientTimeout(
+                total=timeout if timeout else DEFAULT_RINGING_TIMEOUT
+            )
+        elif timeout:
+            client_timeout = aiohttp.ClientTimeout(total=timeout)
+
         return await self._client.request(
             SVC,
             "AcceptWhatsAppCall",
             request,
             self._auth_header(VideoGrants(room_create=True)),
             AcceptWhatsAppCallResponse,
+            timeout=client_timeout,
         )
 
     async def connect_twilio_call(

{livekit_api-1.1.1 → livekit_api-1.2.1}/livekit/api/egress_service.py

@@ -9,6 +9,7 @@ from livekit.protocol.egress import (
     UpdateStreamRequest,
     ListEgressRequest,
     StopEgressRequest,
+    StartEgressRequest,
     EgressInfo,
     ListEgressResponse,
 )
@@ -33,8 +34,15 @@ class EgressService(Service):
     Also see https://docs.livekit.io/home/egress/overview/
     """
 
-    def __init__(self, session: aiohttp.ClientSession, url: str, api_key: str, api_secret: str):
-        super().__init__(session, url, api_key, api_secret)
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        url: str,
+        api_key: str,
+        api_secret: str,
+        failover: bool = True,
+    ):
+        super().__init__(session, url, api_key, api_secret, failover=failover)
 
     async def start_room_composite_egress(self, start: RoomCompositeEgressRequest) -> EgressInfo:
         """Starts a composite recording of a room."""
@@ -86,6 +94,16 @@ class EgressService(Service):
             EgressInfo,
         )
 
+    async def start_egress(self, start: StartEgressRequest) -> EgressInfo:
+        """Starts an egress; the request's source and outputs determine the egress type."""
+        return await self._client.request(
+            SVC,
+            "StartEgress",
+            start,
+            self._auth_header(VideoGrants(room_record=True)),
+            EgressInfo,
+        )
+
     async def update_layout(self, update: UpdateLayoutRequest) -> EgressInfo:
         """Updates the layout of a composite recording."""
         return await self._client.request(

{livekit_api-1.1.1 → livekit_api-1.2.1}/livekit/api/ingress_service.py

@@ -28,8 +28,15 @@ class IngressService(Service):
     Also see https://docs.livekit.io/home/ingress/overview/
     """
 
-    def __init__(self, session: aiohttp.ClientSession, url: str, api_key: str, api_secret: str):
-        super().__init__(session, url, api_key, api_secret)
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        url: str,
+        api_key: str,
+        api_secret: str,
+        failover: bool = True,
+    ):
+        super().__init__(session, url, api_key, api_secret, failover=failover)
 
     async def create_ingress(self, create: CreateIngressRequest) -> IngressInfo:
         return await self._client.request(