Quickstart
Get from zero to your first AI response in 5 minutes.
1. Create an account
Sign up at the NuRoute dashboard. During signup you create your organisation, and all projects and API keys live under it. Verify your email address from the link we send: creating API keys and sending requests need it (until then, 403 email_not_verified).
2. Pick a model
Models come from two places: providers your admin has connected platform-wide, and any provider you connect yourself with your own API key (BYOK). Your own key always takes priority for that provider. Go to the dashboard's Model Catalog / Providers tabs to connect a key and see which models are currently available to you. See Providers & Models for the full catalog, or the BYOK guide for how to connect a key.
3. Create an API key
Go to Settings → API Keys, click Create key. Copy the key: it starts with aicp- and is shown only once.
4. Make your first request
- curl
- JavaScript
- Python
curl https://your-gateway/v1/chat/completions \
-H "Authorization: Bearer aicp-..." \
-H "Content-Type: application/json" \
-d '{
"model": "auto",
"messages": [{ "role": "user", "content": "Hello!" }]
}'
npm install @aicp/sdk
import { NuRouteClient } from '@aicp/sdk';
const client = new NuRouteClient({
apiKey: 'aicp-...',
baseUrl: 'https://your-gateway',
});
const response = await client.chat.complete({
model: 'auto',
messages: [{ role: 'user', content: 'Hello!' }],
});
console.log(response.choices[0].message.content);
pip install nuroute
from nuroute import NuRouteClient
client = NuRouteClient(
api_key="aicp-...",
base_url="https://your-gateway",
)
response = client.chat.complete(
model="auto",
messages=[{"role": "user", "content": "Hello!"}],
)
print(response["choices"][0]["message"]["content"])
With model: "auto", Artemis Task picks the model. The response's
X-Router-Version header says which router decided: v2 for Artemis Task, or v1 when Artemis Task
couldn't decide and fallback-router:apollo did; X-Router-Fallback then says why.
Prefer a visual workflow builder? The official n8n-nodes-nuroute community node sends chat completions through NuRoute without writing any integration code. See the n8n connector guide.
Using Claude Desktop or another MCP client? The official nuroute-mcp-server lets it send chat completions through your NuRoute gateway directly. See the MCP connector guide.
Building with LangChain? The official langchain-nuroute
package ships ChatNuRoute, a normal BaseChatModel that plugs into any chain or agent. See the
LangChain connector guide.
Building with the Vercel AI SDK? The official nuroute-ai-sdk
package lets generateText/streamText route through NuRoute the same way you'd use
@ai-sdk/openai. See the Vercel AI SDK connector guide.
Building on Dify? The official NuRoute model provider plugin lets Dify apps and agents route through your gateway directly from the model dropdown. See the Dify plugin guide.
Building with CrewAI? No package needed — CrewAI's built-in LLM class talks to NuRoute
directly. See the CrewAI guide.
Automating with Zapier? The NuRoute integration sends chat completions through your gateway from any Zap. See the Zapier connector guide.
Automating with Make? The NuRoute integration sends chat completions through your gateway from any scenario. See the Make connector guide.