README.md

Generate

(generate)

Overview

Operations related to AI generate api

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

text_to_image

Generate images from text prompts.

Example Usage

from livepeer import Livepeer

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

res = s.generate.text_to_image(request={
    "prompt": "<value>",
})

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

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 Object	Status Code	Content Type
errors.GenTextToImageResponseBody	400	application/json
errors.GenTextToImageGenerateResponseBody	401	application/json
errors.GenTextToImageGenerateResponseResponseBody	422	application/json
errors.GenTextToImageGenerateResponse500ResponseBody	500	application/json
errors.SDKError	4xx-5xx	/

image_to_image

Apply image transformations to a provided image.

Example Usage

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

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 Object	Status Code	Content Type
errors.GenImageToImageResponseBody	400	application/json
errors.GenImageToImageGenerateResponseBody	401	application/json
errors.GenImageToImageGenerateResponseResponseBody	422	application/json
errors.GenImageToImageGenerateResponse500ResponseBody	500	application/json
errors.SDKError	4xx-5xx	/

image_to_video

Generate a video from a provided image.

Example Usage

from livepeer import Livepeer

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

res = s.generate.image_to_video(request={
    "image": {
        "file_name": "example.file",
        "content": open("example.file", "rb"),
    },
})

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

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 Object	Status Code	Content Type
errors.GenImageToVideoResponseBody	400	application/json
errors.GenImageToVideoGenerateResponseBody	401	application/json
errors.GenImageToVideoGenerateResponseResponseBody	422	application/json
errors.GenImageToVideoGenerateResponse500ResponseBody	500	application/json
errors.SDKError	4xx-5xx	/

upscale

Upscale an image by increasing its resolution.

Example Usage

from livepeer import Livepeer

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

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

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

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 Object	Status Code	Content Type
errors.GenUpscaleResponseBody	400	application/json
errors.GenUpscaleGenerateResponseBody	401	application/json
errors.GenUpscaleGenerateResponseResponseBody	422	application/json
errors.GenUpscaleGenerateResponse500ResponseBody	500	application/json
errors.SDKError	4xx-5xx	/

audio_to_text

Transcribe audio files to text.

Example Usage

from livepeer import Livepeer

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

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

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

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 Object	Status Code	Content Type
errors.GenAudioToTextResponseBody	400	application/json
errors.GenAudioToTextGenerateResponseBody	401	application/json
errors.GenAudioToTextGenerateResponseResponseBody	413	application/json
errors.GenAudioToTextGenerateResponse422ResponseBody	422	application/json
errors.GenAudioToTextGenerateResponse500ResponseBody	500	application/json
errors.SDKError	4xx-5xx	/

segment_anything2

Segment objects in an image.

Example Usage

from livepeer import Livepeer

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

res = s.generate.segment_anything2(request={
    "image": {
        "file_name": "example.file",
        "content": open("example.file", "rb"),
    },
})

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

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 Object	Status Code	Content Type
errors.GenSegmentAnything2ResponseBody	400	application/json
errors.GenSegmentAnything2GenerateResponseBody	401	application/json
errors.GenSegmentAnything2GenerateResponseResponseBody	422	application/json
errors.GenSegmentAnything2GenerateResponse500ResponseBody	500	application/json
errors.SDKError	4xx-5xx	/