# KiwiWhale

KiwiWhale is an AI media generation platform for creating images, videos, audio, text, and other media through browser playgrounds and API access.

## Public website

- Homepage: https://kiwiwhale.com/
- Models: https://kiwiwhale.com/
- Showroom: https://kiwiwhale.com/showroom.php
- Generations: https://kiwiwhale.com/generations.php
- API Key: https://kiwiwhale.com/api_key.php
- Billing: https://kiwiwhale.com/billing.php
- Blog / Discord: https://kiwiwhale.com/blog.php
- Affiliate Program: https://kiwiwhale.com/affiliate.php
- Contact: https://kiwiwhale.com/contact.php
- Terms & Privacy: https://kiwiwhale.com/terms.php

## Contact

- Public contact email: contact@kiwiwhale.com
- Discord community: https://discord.gg/5m8Rtrkwh

## Platform modes

KiwiWhale supports three usage modes:

1. Human mode
2. Hybrid mode
3. Agent mode

Human mode:
- Browser login
- Session authentication
- UI-based model usage
- Manual billing and checkout

Hybrid mode:
- Human-owned account
- Agent uses that account's API key
- Agent can generate, poll jobs, and trigger billing flows

Agent mode:
- API-key native
- Autonomous payment method setup
- Autonomous top-up
- Async generation and polling

## Core docs

- Agents: https://kiwiwhale.com/docs/agents.php
- Auth: https://kiwiwhale.com/docs/auth.php
- Billing: https://kiwiwhale.com/docs/billing.php
- Models: https://kiwiwhale.com/docs/models.php

## Machine-readable discovery

- OpenAPI: https://kiwiwhale.com/openapi.json
- Agent descriptor: https://kiwiwhale.com/.well-known/agent.json
- LLM discovery file: https://kiwiwhale.com/llms.txt

## Auth

Use a KiwiWhale API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Do not share private API keys, passwords, payment details, or provider keys in public places.

## Primary API endpoints

- POST /api/v1/agent_register.php
- GET /api/v1/credits.php
- GET /api/v1/models.php
- POST /api/v1/generate.php
- GET /api/v1/jobs.php?job_id=...
- POST /api/v1/agent_setup_payment.php
- POST /api/v1/agent_confirm_payment_method.php
- POST /api/v1/agent_topup.php

## Billing

- KiwiWhale uses credits as the wallet unit.
- Generations may deduct credits based on the selected model and settings.
- Billing, receipts, and usage details are handled through the user's KiwiWhale account.
- Autonomous top-up supports fixed and buffer modes where available.
- Minimum top-up amounts may be enforced platform-wide.

## Model pages

Individual model pages use this pattern:

- Details: /model.php?model=PUBLIC_MODEL
- Playground: /model-playground.php?model=PUBLIC_MODEL
- API: /model-api.php?model=PUBLIC_MODEL
- Docs: /model-docs.php?model=PUBLIC_MODEL
- Code: /model-code.php?model=PUBLIC_MODEL

PUBLIC_MODEL should be replaced with the model identifier from the KiwiWhale model catalog.