olares-router

Configure and call AI models through the Olares Router gateway via olares-cli.

5.2k|321|Updated Apr 29, 2024
One-click install
npx skills add https://github.com/beclab/Olares --skill olares-router
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: olares-router
Source: https://github.com/beclab/Olares/tree/main/cli/skills/olares-router
Command: npx skills add https://github.com/beclab/Olares --skill olares-router

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Managing AI models on a self-hosted Olares system requires coordinating cloud vendor credentials, local model applications, API keys, quotas, and routing defaults across two separate planes (the Router gateway and each model's own console). This Skill gives an AI agent the operational knowledge to perform all of that through the olares-cli router command family without guesswork.

Core Features & Use Cases

  • Provider and model management: Create cloud vendor providers (OpenAI, Anthropic, DeepSeek, OpenAI-compatible endpoints), import or sync their models, rotate credentials with versioned history, and validate stored keys.
  • Local model lifecycle: Install LLM, embedding, audio, and OCR model applications, track weight downloads, edit model cards (mode, engine args, capabilities), and retry or restart engines.
  • Routing, access, and billing: Create aliases, groups, and default categories, issue scoped sk- API keys, set budget/rpm/tpm/concurrency quotas, and read usage and audit records.
  • Direct model calls: Run chat, embeddings, rerank, search, scrape, translate, image/video/music/3D generation, transcription, speech synthesis, diarization, and OCR from the command line.
  • Use Case: A user asks to add an OpenAI key, install a Qwen model locally, set it as the default chat model, and issue a quota-limited key for a CI script — the agent executes the full sequence with correct layer attribution and safety checks.

Quick Start

Ask the agent to list the models currently configured on this Olares and show which model answers the default chat category.

Frequently Asked Questions about olares-router

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add an OpenAI or Anthropic API key to Olares?

Use olares-cli router provider create with the vendor type, base URL, and credentials passed via --credentials-json from a file or stdin, then import models with router model import. Add --validate to probe the upstream immediately so a wrong key is caught at setup.

How do I install a local LLM like Qwen or Gemma on Olares?

Install a pinned model application with olares-cli market install, or clone an engine base (llama.cpp, vLLM, Ollama, SGLang) with market clone. Router automatically creates the provider row; track weight download with router model progress.

Why does my Olares model show running but calls fail?

A running container and a working model are separate states: weights may still be downloading or loading after the app reports running. Check router model status and router model progress to see the model's own phase before changing any configuration.

Does calling a model through Olares Router require an API key?

No. Since Router v2.2.1, calls without an Authorization header are attributed to the active Olares profile identity. Keys are only needed for model allowlists, separate budgets, or callers outside the Olares platform.

How do I set spending limits or rate limits on model usage?

Use router quota set scoped to a key, user, model, or caller application, with --budget for total dollar spend, --rpm/--tpm for rate limits, or --concurrent for in-flight calls. A ceiling of 0 blocks all calls in that scope without deleting anything.

What are the limitations of the olares-router CLI skill?

It requires Olares 1.12.7+, an admin profile for most management verbs, and cannot manage application lifecycle operations like stop, resume, or GPU binding, which belong to olares-market and olares-settings. Router also has no idempotency keys, so timed-out writes must not be blindly retried.