Official Python SDK for the WaveSpeed inference platform
pip install wavespeed
Run WaveSpeed AI models with a simple API:
import wavespeed output = wavespeed.run( "wavespeed-ai/z-image/turbo", {"prompt": "Cat"}, ) print(output["outputs"][0]) # Output URL
Set your API key via environment variable (You can get your API key from https://wavespeed.ai/accesskey):
export WAVESPEED_API_KEY="your-api-key"
Or pass it directly:
from wavespeed import Client client = Client(api_key="your-api-key") output = client.run("wavespeed-ai/z-image/turbo", {"prompt": "Cat"})
output = wavespeed.run( "wavespeed-ai/z-image/turbo", {"prompt": "Cat"}, timeout=36000.0, # Max wait time in seconds (default: 36000.0) poll_interval=1.0, # Status check interval (default: 1.0) enable_sync_mode=False, # Best-effort sync result attempt (default: False) )
Use enable_sync_mode=True to ask the API to wait for the result in the initial
request. If the server-side sync wait times out, the SDK raises an error with
the task ID/result URL; the task continues processing and can be queried later.
Note: Not all models support sync mode. Check the model documentation for availability.
output = wavespeed.run( "wavespeed-ai/z-image/turbo", {"prompt": "Cat"}, enable_sync_mode=True, )
Configure retries at the client level:
from wavespeed import Client client = Client( api_key="your-api-key", max_retries=0, # Replacement task attempts (default: 0) max_connection_retries=5, # Result-query GET retries; POST is never retried retry_interval=1.0, # Base delay between retries in seconds (default: 1.0) )
Upload images, videos, or audio files:
import wavespeed url = wavespeed.upload("/path/to/image.png") print(url)
# Run all tests python -m pytest # Run a single test file python -m pytest tests/test_api.py # Run a specific test python -m pytest tests/test_api.py::TestClient::test_run_success -v
| Variable | Description |
|---|---|
WAVESPEED_API_KEY |
WaveSpeed API key |
WAVESPEED_CLIENT_NAME |
Channel-attribution name sent as the X-Client-Name header (overrides the client_name parameter; defaults to wavespeed-python) |
MIT
WaveSpeed AI — AI image & video generation platform. Try it in the browser: Image generator · Video generator