livepeer 0.3.0
Python Client SDK for Livepeer Studio
Requires Python: <4.0,>=3.8

# Livepeer Python Library

The Livepeer Python library provides convenient access to the Livepeer Studio API from
applications written in Python

## Documentation

For full documentation and examples, please visit [docs.livepeer.org](https://docs.livepeer.org/sdks/python/).

<!-- Start SDK Installation [installation] -->
## SDK Installation

The SDK can be installed with either *pip* or *poetry* package managers.

### PIP

*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

```bash
pip install livepeer
```

### Poetry

*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.

```bash
poetry add livepeer
```
<!-- End SDK Installation [installation] -->

<!-- No SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```python
import livepeer
from livepeer.models import components

s = livepeer.Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

req = components.NewStreamPayload(
    name='test_stream',
)

res = s.stream.create(req)

if res.stream is not None:
    # handle response
    pass

```

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>

### [access_control](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/accesscontrol/README.md)

* [create](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/accesscontrol/README.md#create) - Create a signing key
* [get_all](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/accesscontrol/README.md#get_all) - Retrieves signing keys
* [delete](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/accesscontrol/README.md#delete) - Delete Signing Key
* [get](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/accesscontrol/README.md#get) - Retrieves a signing key
* [update](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/accesscontrol/README.md#update) - Update a signing key

### [asset](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/asset/README.md)

* [get_all](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/asset/README.md#get_all) - Retrieve assets
* [create](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/asset/README.md#create) - Upload an asset
* [create_via_url](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/asset/README.md#create_via_url) - Upload asset via URL
* [get](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/asset/README.md#get) - Retrieves an asset
* [update](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/asset/README.md#update) - Patch an asset
* [delete](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/asset/README.md#delete) - Delete an asset

### [generate](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/generate/README.md)

* [text_to_image](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/generate/README.md#text_to_image) - Text To Image
* [image_to_image](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/generate/README.md#image_to_image) - Image To Image
* [image_to_video](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/generate/README.md#image_to_video) - Image To Video
* [upscale](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/generate/README.md#upscale) - Upscale
* [audio_to_text](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/generate/README.md#audio_to_text) - Audio To Text
* [segment_anything2](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/generate/README.md#segment_anything2) - Segment Anything 2


### [metrics](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/metrics/README.md)

* [get_realtime_viewership](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/metrics/README.md#get_realtime_viewership) - Query realtime viewership
* [get_viewership](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/metrics/README.md#get_viewership) - Query viewership metrics
* [get_creator_viewership](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/metrics/README.md#get_creator_viewership) - Query creator viewership metrics
* [get_public_viewership](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/metrics/README.md#get_public_viewership) - Query public total views metrics
* [get_usage](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/metrics/README.md#get_usage) - Query usage metrics

### [multistream](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/multistream/README.md)

* [get_all](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/multistream/README.md#get_all) - Retrieve Multistream Targets
* [create](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/multistream/README.md#create) - Create a multistream target
* [get](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/multistream/README.md#get) - Retrieve a multistream target
* [update](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/multistream/README.md#update) - Update Multistream Target
* [delete](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/multistream/README.md#delete) - Delete a multistream target

### [playback](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/playback/README.md)

* [get](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/playback/README.md#get) - Retrieve Playback Info

### [~~room~~](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/room/README.md)

* [~~create~~](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/room/README.md#create) - Create a room :warning: **Deprecated**
* [~~get~~](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/room/README.md#get) - Retrieve a room :warning: **Deprecated**
* [~~delete~~](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/room/README.md#delete) - Delete a room :warning: **Deprecated**
* [~~start_egress~~](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/room/README.md#start_egress) - Start room RTMP egress :warning: **Deprecated**
* [~~stop_egress~~](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/room/README.md#stop_egress) - Stop room RTMP egress :warning: **Deprecated**
* [~~create_user~~](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/room/README.md#create_user) - Create a room user :warning: **Deprecated**
* [~~get_user~~](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/room/README.md#get_user) - Get user details :warning: **Deprecated**
* [~~update_user~~](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/room/README.md#update_user) - Update a room user :warning: **Deprecated**
* [~~delete_user~~](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/room/README.md#delete_user) - Remove a user from the room :warning: **Deprecated**

### [session](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/session/README.md)

* [get_clips](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/session/README.md#get_clips) - Retrieve clips of a session
* [get_all](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/session/README.md#get_all) - Retrieve sessions
* [get](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/session/README.md#get) - Retrieve a session
* [get_recorded](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/session/README.md#get_recorded) - Retrieve Recorded Sessions

### [stream](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/stream/README.md)

* [create](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/stream/README.md#create) - Create a stream
* [get_all](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/stream/README.md#get_all) - Retrieve streams
* [get](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/stream/README.md#get) - Retrieve a stream
* [update](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/stream/README.md#update) - Update a stream
* [delete](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/stream/README.md#delete) - Delete a stream
* [terminate](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/stream/README.md#terminate) - Terminates a live stream
* [start_pull](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/stream/README.md#start_pull) - Start ingest for a pull stream
* [create_clip](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/stream/README.md#create_clip) - Create a clip
* [get_clips](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/stream/README.md#get_clips) - Retrieve clips of a livestream
* [add_multistream_target](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/stream/README.md#add_multistream_target) - Add a multistream target
* [remove_multistream_target](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/stream/README.md#remove_multistream_target) - Remove a multistream target

### [task](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/task/README.md)

* [get_all](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/task/README.md#get_all) - Retrieve Tasks
* [get](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/task/README.md#get) - Retrieve a Task

### [transcode](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/transcode/README.md)

* [create](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/transcode/README.md#create) - Transcode a video

### [webhook](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/webhook/README.md)

* [get_all](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/webhook/README.md#get_all) - Retrieve a Webhook
* [create](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/webhook/README.md#create) - Create a webhook
* [get](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/webhook/README.md#get) - Retrieve a webhook
* [update](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/webhook/README.md#update) - Update a webhook
* [delete](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/webhook/README.md#delete) - Delete a webhook
* [get_logs](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/webhook/README.md#get_logs) - Retrieve webhook logs
* [get_log](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/webhook/README.md#get_log) - Retrieve a webhook log
* [resend_log](https://github.com/livepeer/livepeer-python/blob/master/docs/sdks/webhook/README.md#resend_log) - Resend a webhook

</details>
<!-- End Available Resources and Operations [operations] -->

<!-- Start File uploads [file-upload] -->
## File uploads

Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

> [!TIP]
>
> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
>

```python
from livepeer import Livepeer

s = Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.generate.image_to_image(request={
    "prompt": "<value>",
    "image": {
        "file_name": "example.file",
        "content": open("example.file", "rb"),
    },
})

if res.image_response is not None:
    # handle response
    pass

```
<!-- End File uploads [file-upload] -->

<!-- Start Retries [retries] -->
## Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
from livepeer import Livepeer
from livepeer.models import components
from livepeer.utils import BackoffStrategy, RetryConfig

s = Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.stream.create(request={
    "name": "test_stream",
    "pull": {
        "source": "https://myservice.com/live/stream.flv",
        "headers": {
            "Authorization": "Bearer 123",
        },
        "location": {
            "lat": 39.739,
            "lon": -104.988,
        },
    },
    "playback_policy": {
        "type": components.Type.WEBHOOK,
        "webhook_id": "1bde4o2i6xycudoy",
        "webhook_context": {
            "streamerId": "my-custom-id",
        },
        "refresh_interval": 600,
    },
    "profiles": [
        {
            "width": 1280,
            "name": "720p",
            "height": 720,
            "bitrate": 3000000,
            "fps": 30,
            "fps_den": 1,
            "quality": 23,
            "gop": "2",
            "profile": components.Profile.H264_BASELINE,
        },
    ],
    "record": False,
    "recording_spec": {
        "profiles": [
            {
                "bitrate": 3000000,
                "width": 1280,
                "name": "720p",
                "height": 720,
                "quality": 23,
                "fps": 30,
                "fps_den": 1,
                "gop": "2",
                "profile": components.TranscodeProfileProfile.H264_BASELINE,
                "encoder": components.TranscodeProfileEncoder.H_264,
            },
        ],
    },
    "multistream": {
        "targets": [
            {
                "profile": "720p",
                "video_only": False,
                "id": "PUSH123",
                "spec": {
                    "url": "rtmps://live.my-service.tv/channel/secretKey",
                    "name": "My target",
                },
            },
        ],
    },
},
    RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

if res.stream is not None:
    # handle response
    pass

```

If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
```python
from livepeer import Livepeer
from livepeer.models import components
from livepeer.utils import BackoffStrategy, RetryConfig

s = Livepeer(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.stream.create(request={
    "name": "test_stream",
    "pull": {
        "source": "https://myservice.com/live/stream.flv",
        "headers": {
            "Authorization": "Bearer 123",
        },
        "location": {
            "lat": 39.739,
            "lon": -104.988,
        },
    },
    "playback_policy": {
        "type": components.Type.WEBHOOK,
        "webhook_id": "1bde4o2i6xycudoy",
        "webhook_context": {
            "streamerId": "my-custom-id",
        },
        "refresh_interval": 600,
    },
    "profiles": [
        {
            "width": 1280,
            "name": "720p",
            "height": 720,
            "bitrate": 3000000,
            "fps": 30,
            "fps_den": 1,
            "quality": 23,
            "gop": "2",
            "profile": components.Profile.H264_BASELINE,
        },
    ],
    "record": False,
    "recording_spec": {
        "profiles": [
            {
                "bitrate": 3000000,
                "width": 1280,
                "name": "720p",
                "height": 720,
                "quality": 23,
                "fps": 30,
                "fps_den": 1,
                "gop": "2",
                "profile": components.TranscodeProfileProfile.H264_BASELINE,
                "encoder": components.TranscodeProfileEncoder.H_264,
            },
        ],
    },
    "multistream": {
        "targets": [
            {
                "profile": "720p",
                "video_only": False,
                "id": "PUSH123",
                "spec": {
                    "url": "rtmps://live.my-service.tv/channel/secretKey",
                    "name": "My target",
                },
            },
        ],
    },
})

if res.stream is not None:
    # handle response
    pass

```
<!-- End Retries [retries] -->

<!-- Start Error Handling [errors] -->
## Error Handling

Handling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.

| Error Object     | Status Code      | Content Type     |
| ---------------- | ---------------- | ---------------- |
| errors.Error     | 404              | application/json |
| errors.SDKError  | 4xx-5xx          | */*              |

### Example

```python
from livepeer import Livepeer
from livepeer.models import errors

s = Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = None
try:
    res = s.playback.get(id="<id>")

    if res.playback_info is not None:
        # handle response
        pass

except errors.Error as e:
    # handle e.data: errors.ErrorData
    raise(e)
except errors.SDKError as e:
    # handle exception
    raise(e)
```
<!-- End Error Handling [errors] -->

<!-- No Server Selection [server] -->

<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.

For example, you could specify a header for every request that this sdk makes as follows:
```python
from livepeer import Livepeer
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Livepeer(client=http_client)
```

or you could wrap the client with your own custom logic:
```python
from livepeer import Livepeer
from livepeer.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = Livepeer(async_client=CustomClient(httpx.AsyncClient()))
```
<!-- End Custom HTTP Client [http-client] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name        | Type        | Scheme      |
| ----------- | ----------- | ----------- |
| `api_key`   | http        | HTTP Bearer |

To authenticate with the API the `api_key` parameter must be set when initializing the SDK client instance. For example:
```python
from livepeer import Livepeer
from livepeer.models import components

s = Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.stream.create(request={
    "name": "test_stream",
    "pull": {
        "source": "https://myservice.com/live/stream.flv",
        "headers": {
            "Authorization": "Bearer 123",
        },
        "location": {
            "lat": 39.739,
            "lon": -104.988,
        },
    },
    "playback_policy": {
        "type": components.Type.WEBHOOK,
        "webhook_id": "1bde4o2i6xycudoy",
        "webhook_context": {
            "streamerId": "my-custom-id",
        },
        "refresh_interval": 600,
    },
    "profiles": [
        {
            "width": 1280,
            "name": "720p",
            "height": 720,
            "bitrate": 3000000,
            "fps": 30,
            "fps_den": 1,
            "quality": 23,
            "gop": "2",
            "profile": components.Profile.H264_BASELINE,
        },
    ],
    "record": False,
    "recording_spec": {
        "profiles": [
            {
                "bitrate": 3000000,
                "width": 1280,
                "name": "720p",
                "height": 720,
                "quality": 23,
                "fps": 30,
                "fps_den": 1,
                "gop": "2",
                "profile": components.TranscodeProfileProfile.H264_BASELINE,
                "encoder": components.TranscodeProfileEncoder.H_264,
            },
        ],
    },
    "multistream": {
        "targets": [
            {
                "profile": "720p",
                "video_only": False,
                "id": "PUSH123",
                "spec": {
                    "url": "rtmps://live.my-service.tv/channel/secretKey",
                    "name": "My target",
                },
            },
        ],
    },
})

if res.stream is not None:
    # handle response
    pass

```
<!-- End Authentication [security] -->

<!-- Start Summary [summary] -->
## Summary

Livepeer API Reference: Welcome to the Livepeer API reference docs. Here you will find all the
endpoints exposed on the standard Livepeer API, learn how to use them and
what they return.
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents

* [SDK Installation](https://github.com/livepeer/livepeer-python/blob/master/#sdk-installation)
* [IDE Support](https://github.com/livepeer/livepeer-python/blob/master/#ide-support)
* [SDK Example Usage](https://github.com/livepeer/livepeer-python/blob/master/#sdk-example-usage)
* [Available Resources and Operations](https://github.com/livepeer/livepeer-python/blob/master/#available-resources-and-operations)
* [File uploads](https://github.com/livepeer/livepeer-python/blob/master/#file-uploads)
* [Retries](https://github.com/livepeer/livepeer-python/blob/master/#retries)
* [Error Handling](https://github.com/livepeer/livepeer-python/blob/master/#error-handling)
* [Server Selection](https://github.com/livepeer/livepeer-python/blob/master/#server-selection)
* [Custom HTTP Client](https://github.com/livepeer/livepeer-python/blob/master/#custom-http-client)
* [Authentication](https://github.com/livepeer/livepeer-python/blob/master/#authentication)
* [Debugging](https://github.com/livepeer/livepeer-python/blob/master/#debugging)
<!-- End Table of Contents [toc] -->

<!-- Start IDE Support [idesupport] -->
## IDE Support

### PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->

<!-- Start Debugging [debug] -->
## Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.
```python
from livepeer import Livepeer
import logging

logging.basicConfig(level=logging.DEBUG)
s = Livepeer(debug_logger=logging.getLogger("livepeer"))
```
<!-- End Debugging [debug] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->