Skip to main content

Grok-Imagine multimodal generation client for RunAPI

Project description

Grok-Imagine Python SDK for RunAPI

The Grok-Imagine Python SDK is the language-specific package for Grok-Imagine on RunAPI. Use it for text-to-video, image-to-video, text-to-image, and image editing flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Python.

For model details, use https://runapi.ai/models/grok-imagine; for API reference, use https://runapi.ai/docs#grok-imagine; for SDK docs, use https://runapi.ai/docs#sdk-grok-imagine.

Install

pip install runapi-grok-imagine

Quick start

from runapi.grok_imagine import GrokImagineClient

client = GrokImagineClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."

task = client.text_to_video.create(
    model="grok-imagine-text-to-video",
    prompt="A drone shot over a neon cityscape at night",
    output_resolution="720p",
)
status = client.text_to_video.get(task.id)

image = client.text_to_image.create(
    model="grok-imagine-text-to-image",
    prompt="A watercolor fox in a snowy forest",
    aspect_ratio="16:9",
)

Use create to submit a task and return quickly, get to fetch the latest task state, and run to create and poll until completion:

result = client.text_to_video.run(
    model="grok-imagine-text-to-video",
    prompt="A serene mountain lake at dawn",
)
print(result.videos[0].url)

In web request handlers, prefer create plus webhook or later get polling so a worker is not held open.

RunAPI-generated file URLs are temporary. Download and store generated media in your own durable storage within 7 days; do not treat returned URLs as long-term assets.

Language notes

Pass parameters as keyword arguments and catch the runapi.grok_imagine error classes when building media jobs or scripts. The available resources are text_to_video, image_to_video, text_to_image, edit_image, extensions, and upscales. The extensions and upscales resources take a prior task's source_task_id. Keep RUNAPI_API_KEY in the environment or your secret manager; never commit API keys or callback secrets.

Links

License

Licensed under the Apache License, Version 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

runapi_grok_imagine-0.1.0.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runapi_grok_imagine-0.1.0-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file runapi_grok_imagine-0.1.0.tar.gz.

File metadata

  • Download URL: runapi_grok_imagine-0.1.0.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for runapi_grok_imagine-0.1.0.tar.gz
Algorithm Hash digest
SHA256 132ca8342eb54bd486bbdefae0e19d26485e4f80812a99bd2a289984f04a6cac
MD5 7bf3dfba42fe094253a8e6405c2c1e6a
BLAKE2b-256 0fecfc8fbb97baeec66d043956dd94ac1b33b6fe1a3e7d91e42f544349aadb8e

See more details on using hashes here.

File details

Details for the file runapi_grok_imagine-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: runapi_grok_imagine-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for runapi_grok_imagine-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 326fd96abcae70142fae0fa4ab6e540233c0ed7a4e92f1366681a5548e976fd4
MD5 21772ad84a64aa95d3a310217e886f0b
BLAKE2b-256 5f6dbb14faeb1530e70d05da162c46228db68892d2fe468c02a28a808b812b9e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page