File size: 9,311 Bytes
9410704 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 | # This file was auto-generated by Fern from our API Definition.
import typing
from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.request_options import RequestOptions
from ...types.image_generation_request import ImageGenerationRequest
from ...types.media_generation_create_response import MediaGenerationCreateResponse
from ...types.media_generation_list_response import MediaGenerationListResponse
from ...types.media_generation_response import MediaGenerationResponse
from .raw_client import AsyncRawImageClient, RawImageClient
from .types.image_list_request_status import ImageListRequestStatus
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class ImageClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawImageClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawImageClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawImageClient
"""
return self._raw_client
def list(
self,
*,
cursor: typing.Optional[str] = None,
page_size: typing.Optional[int] = None,
status: typing.Optional[ImageListRequestStatus] = None,
model_id: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> MediaGenerationListResponse:
"""
List the image generations created through this API, newest first.
Parameters
----------
cursor : typing.Optional[str]
Pagination cursor: the `next_cursor` value of the previous page's response. Omit it for the first page.
page_size : typing.Optional[int]
How many generations to return per page.
status : typing.Optional[ImageListRequestStatus]
Only return generations with this lifecycle status.
model_id : typing.Optional[str]
Only return generations of this model.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
MediaGenerationListResponse
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.flows.image.list(
cursor="cursor",
page_size=1,
status="pending",
model_id="model_id",
)
"""
_response = self._raw_client.list(
cursor=cursor, page_size=page_size, status=status, model_id=model_id, request_options=request_options
)
return _response.data
def create(
self, *, request: ImageGenerationRequest, request_options: typing.Optional[RequestOptions] = None
) -> MediaGenerationCreateResponse:
"""
Start an image generation with the selected model.
Parameters
----------
request : ImageGenerationRequest
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
MediaGenerationCreateResponse
Successful Response
Examples
--------
from elevenlabs import ElevenLabs, ImageGenerationRequest_BytedanceSeedream5Lite
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.flows.image.create(
request=ImageGenerationRequest_BytedanceSeedream5Lite(
prompt="A corgi in a tiny lifeguard chair on a sunlit beach at golden hour, photorealistic",
),
)
"""
_response = self._raw_client.create(request=request, request_options=request_options)
return _response.data
def get(
self, generation_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> MediaGenerationResponse:
"""
Retrieve the status of an image generation, and retrieve its output URL once completed.
Parameters
----------
generation_id : str
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
MediaGenerationResponse
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.flows.image.get(
generation_id="generation_id",
)
"""
_response = self._raw_client.get(generation_id, request_options=request_options)
return _response.data
class AsyncImageClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawImageClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawImageClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawImageClient
"""
return self._raw_client
async def list(
self,
*,
cursor: typing.Optional[str] = None,
page_size: typing.Optional[int] = None,
status: typing.Optional[ImageListRequestStatus] = None,
model_id: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> MediaGenerationListResponse:
"""
List the image generations created through this API, newest first.
Parameters
----------
cursor : typing.Optional[str]
Pagination cursor: the `next_cursor` value of the previous page's response. Omit it for the first page.
page_size : typing.Optional[int]
How many generations to return per page.
status : typing.Optional[ImageListRequestStatus]
Only return generations with this lifecycle status.
model_id : typing.Optional[str]
Only return generations of this model.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
MediaGenerationListResponse
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.flows.image.list(
cursor="cursor",
page_size=1,
status="pending",
model_id="model_id",
)
asyncio.run(main())
"""
_response = await self._raw_client.list(
cursor=cursor, page_size=page_size, status=status, model_id=model_id, request_options=request_options
)
return _response.data
async def create(
self, *, request: ImageGenerationRequest, request_options: typing.Optional[RequestOptions] = None
) -> MediaGenerationCreateResponse:
"""
Start an image generation with the selected model.
Parameters
----------
request : ImageGenerationRequest
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
MediaGenerationCreateResponse
Successful Response
Examples
--------
import asyncio
from elevenlabs import (
AsyncElevenLabs,
ImageGenerationRequest_BytedanceSeedream5Lite,
)
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.flows.image.create(
request=ImageGenerationRequest_BytedanceSeedream5Lite(
prompt="A corgi in a tiny lifeguard chair on a sunlit beach at golden hour, photorealistic",
),
)
asyncio.run(main())
"""
_response = await self._raw_client.create(request=request, request_options=request_options)
return _response.data
async def get(
self, generation_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> MediaGenerationResponse:
"""
Retrieve the status of an image generation, and retrieve its output URL once completed.
Parameters
----------
generation_id : str
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
MediaGenerationResponse
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.flows.image.get(
generation_id="generation_id",
)
asyncio.run(main())
"""
_response = await self._raw_client.get(generation_id, request_options=request_options)
return _response.data
|