Getting Started
From zero to your first AI-generated result in under five minutes.
What is Whizurai?
Whizurai is an outcome-first AI platform for creators and businesses. You execute capabilities — named AI operations like image:generate or video:create — and the platform returns reusable artifacts you can download, build on, or publish.
You don't pick models or manage infrastructure. You describe what you want to create, and Whizurai produces it.
Quick Start Guide
Create an Account
Sign up at whizur.ai/signup to create your account. During onboarding you'll create your organization and first app.
Generate an API Key
From the dashboard, navigate to Settings → API Keys and create a key for your app. Keys are prefixed cw_dev_* for development and cw_prod_* for production.
Important: API keys are shown only once. Store them in your environment variables — never in source code.
Install the SDK
The official SDKs handle authentication, polling, and artifact retrieval for you. For quick one-off trials you can also use the whizzy CLI.
TypeScript / JavaScript
pnpm add @whizurai/sdk-js
Python
pip install whizurai-sdk
CLI (quick trials)
pnpm add -g @whizurai/cli
Run Your First Capability
Execute the image:generate capability, wait for the result, then read the artifact URL.
TypeScript / JavaScript
import { WhizuraiClient } from '@whizurai/sdk-js'
const client = new WhizuraiClient({ apiKey: process.env.WHIZURAI_API_KEY })
// Execute a capability — returns a Run
const run = await client.capabilities.run('image:generate', {
prompt: 'a red bicycle on a beach at sunset',
})
// Wait for the outcome, then read the artifact
const done = await client.runs.pollUntilDone(run.id)
const [artifact] = await client.artifacts.list({ runId: done.id })
console.log(artifact.url)Python
import os
from whizurai import WhizuraiClient
client = WhizuraiClient(api_key=os.environ["WHIZURAI_API_KEY"])
run = client.capabilities.run("image:generate", {"prompt": "a red bicycle on a beach at sunset"})
done = client.runs.poll_until_done(run.id)
artifact = client.artifacts.list(run_id=done.id)[0]
print(artifact.url)curl (direct API)
curl -X POST https://api.whizur.ai/v1/capabilities/image:generate/execute \
-H "X-API-Key: cw_dev_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{ "input": { "prompt": "a red bicycle on a beach at sunset" } }'What Happens Behind the Scenes
When you call client.capabilities.run():
- Your API key is authenticated and your app is identified
- A Run is created and queued for execution
- The platform executes the capability and produces one or more Artifacts
- Artifacts are stored permanently — reusable as input to future capabilities
pollUntilDoneresolves once the run reaches a terminal state
Every result is a reusable asset. Pass an artifact ID as input to capabilities like image:upscale or image:vary to compound your work.
When to Use Whizurai
Use Whizurai when:
- You need AI-generated outputs quickly without managing models or infrastructure
- You want results that are stored, reusable, and composable
- You need multiple capabilities (images, video, enrichment, and more)
- You want a consistent API surface across every AI operation
Build internally when:
- You have highly specialized AI requirements not covered by available capabilities
- You need complete control over model selection and fine-tuning
- Regulatory requirements mandate on-premise deployment