kiraairoute
v0.1.2
Published
Open-source gateway for using Kira AI with OpenAI-compatible clients.
Maintainers
Readme
KiraAI Route
Open-source local gateway for using Kira AI with OpenAI-compatible clients.
Quick Start
Run:
npx kiraairouteOn first launch, KiraAI Route asks for your Kira API key and saves it locally.
After setup, the local API is available at:
http://127.0.0.1:4010/v1Features
- OpenAI-compatible
/v1/chat/completions - OpenAI-compatible
/v1/responses - Local API gateway
- Kira API key stored locally
- Works with OpenAI-compatible clients
- Designed for Codex and other AI tools
- No need to manually set the API key every time
Supported Free Models
Kira currently provides free daily token allowances for selected models.
| Model | Model ID |
|---|---|
| Kira Mini 1.0 | kira-mini-1.0 |
| Tencent Hy3 Free | hy3 |
| Mimo V2.5 | mimo-v2.5 |
| Kira Mini 2.0 | kira-2.0 |
Availability and limits are determined by Kira AI and may change.
API
Chat Completions
curl http://127.0.0.1:4010/v1/chat/completions ^
-H "Authorization: Bearer YOUR_KIRA_API_KEY" ^
-H "Content-Type: application/json" ^
-d "{\"model\":\"kira-mini-1.0\",\"messages\":[{\"role\":\"user\",\"content\":\"Hello!\"}]}"Responses API
curl http://127.0.0.1:4010/v1/responses ^
-H "Authorization: Bearer YOUR_KIRA_API_KEY" ^
-H "Content-Type: application/json" ^
-d "{\"model\":\"kira-mini-1.0\",\"input\":\"Hello!\"}"Models
List available models:
curl http://127.0.0.1:4010/v1/modelsCodex
KiraAI Route provides a local OpenAI-compatible endpoint:
http://127.0.0.1:4010/v1You can configure compatible clients to use this endpoint and select:
kira-mini-1.0Configuration
On first launch, KiraAI Route asks for your Kira API key.
The key is stored locally at:
~/.kiraairoute/config.jsonYou can also provide the key through an environment variable:
KIRA_API_KEY=your_kira_api_keyThe environment variable takes priority over the saved configuration.
Development
Clone the repository:
git clone YOUR_GITHUB_REPOSITORY
cd kiraairouteInstall dependencies:
npm installBuild:
npm run buildStart:
npm startDevelopment mode:
npm run devProject Structure
kiraairoute/
├── src/
│ ├── cli/
│ │ ├── cli.ts
│ │ ├── config.ts
│ │ └── ui.ts
│ ├── server/
│ │ ├── server.ts
│ │ ├── routes.ts
│ │ └── middleware.ts
│ ├── kira/
│ │ ├── client.ts
│ │ └── models.ts
│ ├── protocols/
│ │ ├── responses.ts
│ │ └── chat.ts
│ ├── config/
│ │ └── constants.ts
│ └── index.ts
├── dist/
├── README.md
├── package.json
├── tsconfig.json
├── .gitignore
└── LICENSESecurity
Never commit your Kira API key to GitHub.
Do not put real API keys in:
- Source code
- README files
.envfiles committed to Git- Screenshots
- GitHub issues
License
MIT
