Built for people and AI agents
Every page here is human-readable — task guides and concepts — backed by a complete OpenAPI contract. The same reference is bundled in an open cookbook you can clone into your project in seconds.
Working with an AI agent? Clone the cookbook
RecommendedPoint your agent at PLAYBOOK.md — a step-by-step guide to the API reference and working examples, so it reads only what each step needs.
View the cookbook on GitHubPrefer to paste context instead? Download the full docs as one Markdown file, or grab just the raw spec.
All API requests require an API key in the X-API-Key header.
Create a key from the API Keys page in the portal. The full key is shown only once — save it securely. Lost keys cannot be recovered; revoke and create a new one.
curl https://fiwano.com/api/v1/channels \
-H "X-API-Key: YOUR_API_KEY"
All keys start with mip_live_. Keys are hashed on our side.
Every error response uses the same shape — a detail field with a human-readable description:
{ "detail": "Human-readable error description" }
Some validation errors carry a structured detail object instead (for example text_too_long when sending overlong text); the per-endpoint shapes are in the API Reference.
| Code | Meaning | What to do |
|---|---|---|
200 |
Success | — |
201 |
Created | — |
400 |
Bad request | Check the detail field |
401 |
Unauthorized | Check your X-API-Key header |
402 |
Payment required | Trial ended or subscription inactive — see Subscriptions & Billing |
404 |
Not found | Resource doesn't exist or belongs to another account |
429 |
Rate limit exceeded | Back off and retry after Retry-After — see rate limits |
502 |
Meta API error | Upstream failure. Check detail. Retry may help. |
503 |
Temporarily overloaded | Transient load shedding. Retry after Retry-After. |
Fiwano API Documentation