Generate

(generate)

Overview

Available Operations

text_to_image - Text To Image
image_to_image - Image To Image
image_to_video - Image To Video
upscale - Upscale
audio_to_text - Audio To Text
segment_anything2 - Segment Anything 2
llm - LLM
image_to_text - Image To Text
live_video_to_video - Live Video To Video
text_to_speech - Text To Speech

text_to_image

Generate images from text prompts.

Example Usage

from livepeer_ai import Livepeer

with Livepeer(
    http_bearer="<YOUR_BEARER_TOKEN_HERE>",
) as livepeer:

    res = livepeer.generate.text_to_image(request={
        "prompt": "<value>",
        "model_id": "",
        "loras": "",
        "height": 576,
        "width": 1024,
        "guidance_scale": 7.5,
        "negative_prompt": "",
        "safety_check": True,
        "num_inference_steps": 50,
        "num_images_per_prompt": 1,
    })

    assert res.image_response is not None

    # Handle response
    print(res.image_response)

Parameters

Parameter	Type	Required	Description
`request`	components.TextToImageParams	✔️	The request object to use for the request.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GenTextToImageResponse

Errors

Error Type	Status Code	Content Type
errors.HTTPError	400, 401	application/json
errors.HTTPValidationError	422	application/json
errors.HTTPError	500	application/json
errors.SDKError	4XX, 5XX	/

image_to_image

Apply image transformations to a provided image.

Example Usage

from livepeer_ai import Livepeer

with Livepeer(
    http_bearer="<YOUR_BEARER_TOKEN_HERE>",
) as livepeer:

    res = livepeer.generate.image_to_image(request={
        "prompt": "<value>",
        "image": {
            "file_name": "example.file",
            "content": open("example.file", "rb"),
        },
        "model_id": "",
        "loras": "",
        "strength": 0.8,
        "guidance_scale": 7.5,
        "image_guidance_scale": 1.5,
        "negative_prompt": "",
        "safety_check": True,
        "num_inference_steps": 100,
        "num_images_per_prompt": 1,
    })

    assert res.image_response is not None

    # Handle response
    print(res.image_response)

Parameters

Parameter	Type	Required	Description
`request`	components.BodyGenImageToImage	✔️	The request object to use for the request.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GenImageToImageResponse

Errors

Error Type	Status Code	Content Type
errors.HTTPError	400, 401	application/json
errors.HTTPValidationError	422	application/json
errors.HTTPError	500	application/json
errors.SDKError	4XX, 5XX	/

image_to_video

Generate a video from a provided image.

Example Usage

from livepeer_ai import Livepeer

with Livepeer(
    http_bearer="<YOUR_BEARER_TOKEN_HERE>",
) as livepeer:

    res = livepeer.generate.image_to_video(request={
        "image": {
            "file_name": "example.file",
            "content": open("example.file", "rb"),
        },
        "model_id": "",
        "height": 576,
        "width": 1024,
        "fps": 6,
        "motion_bucket_id": 127,
        "noise_aug_strength": 0.02,
        "safety_check": True,
        "num_inference_steps": 25,
    })

    assert res.video_response is not None

    # Handle response
    print(res.video_response)

Parameters

Parameter	Type	Required	Description
`request`	components.BodyGenImageToVideo	✔️	The request object to use for the request.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GenImageToVideoResponse

Errors

Error Type	Status Code	Content Type
errors.HTTPError	400, 401	application/json
errors.HTTPValidationError	422	application/json
errors.HTTPError	500	application/json
errors.SDKError	4XX, 5XX	/

upscale

Upscale an image by increasing its resolution.

Example Usage

from livepeer_ai import Livepeer

with Livepeer(
    http_bearer="<YOUR_BEARER_TOKEN_HERE>",
) as livepeer:

    res = livepeer.generate.upscale(request={
        "prompt": "<value>",
        "image": {
            "file_name": "example.file",
            "content": open("example.file", "rb"),
        },
        "model_id": "",
        "safety_check": True,
        "num_inference_steps": 75,
    })

    assert res.image_response is not None

    # Handle response
    print(res.image_response)

Parameters

Parameter	Type	Required	Description
`request`	components.BodyGenUpscale	✔️	The request object to use for the request.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GenUpscaleResponse

Errors

Error Type	Status Code	Content Type
errors.HTTPError	400, 401	application/json
errors.HTTPValidationError	422	application/json
errors.HTTPError	500	application/json
errors.SDKError	4XX, 5XX	/

audio_to_text

Transcribe audio files to text.

Example Usage

from livepeer_ai import Livepeer

with Livepeer(
    http_bearer="<YOUR_BEARER_TOKEN_HERE>",
) as livepeer:

    res = livepeer.generate.audio_to_text(request={
        "audio": {
            "file_name": "example.file",
            "content": open("example.file", "rb"),
        },
        "model_id": "",
        "return_timestamps": "true",
    })

    assert res.text_response is not None

    # Handle response
    print(res.text_response)

Parameters

Parameter	Type	Required	Description
`request`	components.BodyGenAudioToText	✔️	The request object to use for the request.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GenAudioToTextResponse

Errors

Error Type	Status Code	Content Type
errors.HTTPError	400, 401, 413, 415	application/json
errors.HTTPValidationError	422	application/json
errors.HTTPError	500	application/json
errors.SDKError	4XX, 5XX	/

segment_anything2

Segment objects in an image.

Example Usage

from livepeer_ai import Livepeer

with Livepeer(
    http_bearer="<YOUR_BEARER_TOKEN_HERE>",
) as livepeer:

    res = livepeer.generate.segment_anything2(request={
        "image": {
            "file_name": "example.file",
            "content": open("example.file", "rb"),
        },
        "model_id": "",
        "multimask_output": True,
        "return_logits": True,
        "normalize_coords": True,
    })

    assert res.masks_response is not None

    # Handle response
    print(res.masks_response)

Parameters

Parameter	Type	Required	Description
`request`	components.BodyGenSegmentAnything2	✔️	The request object to use for the request.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GenSegmentAnything2Response

Errors

Error Type	Status Code	Content Type
errors.HTTPError	400, 401	application/json
errors.HTTPValidationError	422	application/json
errors.HTTPError	500	application/json
errors.SDKError	4XX, 5XX	/

llm

Generate text using a language model.

Example Usage

from livepeer_ai import Livepeer

with Livepeer(
    http_bearer="<YOUR_BEARER_TOKEN_HERE>",
) as livepeer:

    res = livepeer.generate.llm(request={
        "messages": [

        ],
        "model": "",
        "temperature": 0.7,
        "max_tokens": 256,
        "top_p": 1,
        "top_k": -1,
        "stream": False,
    })

    assert res.llm_response is not None

    # Handle response
    print(res.llm_response)

Parameters

Parameter	Type	Required	Description
`request`	components.LLMRequest	✔️	The request object to use for the request.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GenLLMResponse

Errors

Error Type	Status Code	Content Type
errors.HTTPError	400, 401	application/json
errors.HTTPValidationError	422	application/json
errors.HTTPError	500	application/json
errors.SDKError	4XX, 5XX	/

image_to_text

Transform image files to text.

Example Usage

from livepeer_ai import Livepeer

with Livepeer(
    http_bearer="<YOUR_BEARER_TOKEN_HERE>",
) as livepeer:

    res = livepeer.generate.image_to_text(request={
        "image": {
            "file_name": "example.file",
            "content": open("example.file", "rb"),
        },
        "prompt": "",
        "model_id": "",
    })

    assert res.image_to_text_response is not None

    # Handle response
    print(res.image_to_text_response)

Parameters

Parameter	Type	Required	Description
`request`	components.BodyGenImageToText	✔️	The request object to use for the request.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GenImageToTextResponse

Errors

Error Type	Status Code	Content Type
errors.HTTPError	400, 401, 413	application/json
errors.HTTPValidationError	422	application/json
errors.HTTPError	500	application/json
errors.SDKError	4XX, 5XX	/

live_video_to_video

Apply transformations to a live video streamed to the returned endpoints.

Example Usage

from livepeer_ai import Livepeer

with Livepeer(
    http_bearer="<YOUR_BEARER_TOKEN_HERE>",
) as livepeer:

    res = livepeer.generate.live_video_to_video(request={
        "subscribe_url": "https://soulful-lava.org/",
        "publish_url": "https://vain-tabletop.biz",
        "control_url": "",
        "events_url": "",
        "model_id": "",
    })

    assert res.live_video_to_video_response is not None

    # Handle response
    print(res.live_video_to_video_response)

Parameters

Parameter	Type	Required	Description
`request`	components.LiveVideoToVideoParams	✔️	The request object to use for the request.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GenLiveVideoToVideoResponse

Errors

Error Type	Status Code	Content Type
errors.HTTPError	400, 401	application/json
errors.HTTPValidationError	422	application/json
errors.HTTPError	500	application/json
errors.SDKError	4XX, 5XX	/

text_to_speech

Generate a text-to-speech audio file based on the provided text input and speaker description.

Example Usage

from livepeer_ai import Livepeer

with Livepeer(
    http_bearer="<YOUR_BEARER_TOKEN_HERE>",
) as livepeer:

    res = livepeer.generate.text_to_speech(request={
        "model_id": "",
        "text": "",
        "description": "A male speaker delivers a slightly expressive and animated speech with a moderate speed and pitch.",
    })

    assert res.audio_response is not None

    # Handle response
    print(res.audio_response)

Parameters

Parameter	Type	Required	Description
`request`	components.TextToSpeechParams	✔️	The request object to use for the request.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GenTextToSpeechResponse

Errors

Error Type	Status Code	Content Type
errors.HTTPError	400, 401	application/json
errors.HTTPValidationError	422	application/json
errors.HTTPError	500	application/json
errors.SDKError	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

Generate

Overview

Available Operations

text_to_image

Example Usage

Parameters

Response

Errors

image_to_image

Example Usage

Parameters

Response

Errors

image_to_video

Example Usage

Parameters

Response

Errors

upscale

Example Usage

Parameters

Response

Errors

audio_to_text

Example Usage

Parameters

Response

Errors

segment_anything2

Example Usage

Parameters

Response

Errors

llm

Example Usage

Parameters

Response

Errors

image_to_text

Example Usage

Parameters

Response

Errors

live_video_to_video

Example Usage

Parameters

Response

Errors

text_to_speech

Example Usage

Parameters

Response

Errors