Skip to content

Add 2K image resolution support #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shawnthapa merged 1 commit into from
Feb 12, 2026
+19 −9
Merged

Add 2K image resolution support #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/xai_sdk/aio/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ async def sample(
Only supported for grok-imagine models.
resolution: The image resolution to generate. One of:
- `"1k"`: ~1 megapixel total. Dimensions vary by aspect ratio.
- `"2k"`: ~4 megapixels total. Dimensions vary by aspect ratio.
Only supported for grok-imagine models.

Returns:
Expand Down Expand Up @@ -142,6 +143,7 @@ async def sample_batch(
Only supported for grok-imagine models.
resolution: The image resolution to generate. One of:
- `"1k"`: ~1 megapixel total. Dimensions vary by aspect ratio.
- `"2k"`: ~4 megapixels total. Dimensions vary by aspect ratio.
Only supported for grok-imagine models.

Returns:
Expand Down
2 changes: 2 additions & 0 deletions src/xai_sdk/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,5 +215,7 @@ def convert_image_resolution_to_pb(resolution: ImageResolution) -> image_pb2.Ima
match resolution:
case "1k":
return image_pb2.ImageResolution.IMG_RESOLUTION_1K
case "2k":
return image_pb2.ImageResolution.IMG_RESOLUTION_2K
case _:
raise ValueError(f"Invalid image resolution {resolution}.")
8 changes: 4 additions & 4 deletions src/xai_sdk/proto/v5/image_pb2.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions src/xai_sdk/proto/v5/image_pb2.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ class ImageResolution(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
__slots__ = ()
IMG_RESOLUTION_INVALID: _ClassVar[ImageResolution]
IMG_RESOLUTION_1K: _ClassVar[ImageResolution]
IMG_RESOLUTION_2K: _ClassVar[ImageResolution]
DETAIL_INVALID: ImageDetail
DETAIL_AUTO: ImageDetail
DETAIL_LOW: ImageDetail
Expand Down Expand Up @@ -77,6 +78,7 @@ IMG_ASPECT_RATIO_1_2: ImageAspectRatio
IMG_ASPECT_RATIO_2_1: ImageAspectRatio
IMG_RESOLUTION_INVALID: ImageResolution
IMG_RESOLUTION_1K: ImageResolution
IMG_RESOLUTION_2K: ImageResolution

class GenerateImageRequest(_message.Message):
__slots__ = ("prompt", "image", "model", "n", "user", "format", "aspect_ratio", "resolution")
Expand Down
8 changes: 4 additions & 4 deletions src/xai_sdk/proto/v6/image_pb2.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions src/xai_sdk/proto/v6/image_pb2.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ class ImageResolution(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
__slots__ = ()
IMG_RESOLUTION_INVALID: _ClassVar[ImageResolution]
IMG_RESOLUTION_1K: _ClassVar[ImageResolution]
IMG_RESOLUTION_2K: _ClassVar[ImageResolution]
DETAIL_INVALID: ImageDetail
DETAIL_AUTO: ImageDetail
DETAIL_LOW: ImageDetail
Expand Down Expand Up @@ -78,6 +79,7 @@ IMG_ASPECT_RATIO_1_2: ImageAspectRatio
IMG_ASPECT_RATIO_2_1: ImageAspectRatio
IMG_RESOLUTION_INVALID: ImageResolution
IMG_RESOLUTION_1K: ImageResolution
IMG_RESOLUTION_2K: ImageResolution

class GenerateImageRequest(_message.Message):
__slots__ = ("prompt", "image", "model", "n", "user", "format", "aspect_ratio", "resolution")
Expand Down
2 changes: 2 additions & 0 deletions src/xai_sdk/sync/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ def sample(
Only supported for grok-imagine models.
resolution: The image resolution to generate. One of:
- `"1k"`: ~1 megapixel total. Dimensions vary by aspect ratio.
- `"2k"`: ~4 megapixels total. Dimensions vary by aspect ratio.
Only supported for grok-imagine models.

Returns:
Expand Down Expand Up @@ -142,6 +143,7 @@ def sample_batch(
Only supported for grok-imagine models.
resolution: The image resolution to generate. One of:
- `"1k"`: ~1 megapixel total. Dimensions vary by aspect ratio.
- `"2k"`: ~4 megapixels total. Dimensions vary by aspect ratio.
Only supported for grok-imagine models.

Returns:
Expand Down
2 changes: 1 addition & 1 deletion src/xai_sdk/types/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@
"1:2",
"2:1",
]
ImageResolution: TypeAlias = Literal["1k"]
ImageResolution: TypeAlias = Literal["1k", "2k"]