- 00
- Features
- API Key Settings
Settings that travel with the key.
Change routing, retry, fallback or limits on the key in the dashboard. No client code changes, and a request can still override them.
Keys and organization
- Settings per key
- 12
- Default mode
- autoCheapest
- Fallback on a new key
- On
- Retry on a new key
- Off
01Defaults
A new key, unchanged.
| Setting | Default | Options | Request field |
|---|---|---|---|
| Routing mode | autoCheapest | priority, autoCheapest, autoFastest, autoMostReliable | settings.routing.mode |
| Provider order | None | Any providers, in order | settings.routing.providerOrder |
| Excluded providers | None | Up to 20 | settings.routing.excludedProviders |
| Own provider keys | first (inherits the workspace) | first, only, off | settings.routing.byok |
| Key pool | all | all, platformOnly | settings.routing.keyPoolMode |
| Auto Retry | Off | 0 to 10 retries | settings.retry |
| Auto Fallback | On, 2 | 0 to 20 fallbacks | settings.fallback |
| Proxy reuse | Off | On, off | settings.allowProxyReuse |
| Response statistics | Off | On, off | settings.statistics |
| Detailed analytics | On | On, off | settings.analytics |
| Spend caps | None | Up to 5, per any whole number of hours, days or weeks up to 90 days, or in total | Key only |
| Concurrent tasks | – | Up to 100,000 | Key only |
02Request
The same settings, sent with one request.
Each field overrides the key for that request only.
- A field in the request wins.
- Otherwise, the key's setting applies.
- Otherwise, the default in the table above.
settings, in POST /createTask
{
"settings": {
"routing": {
"mode": "autoCheapest",
"keyPoolMode": "all"
},
"fallback": {
"enabled": true,
"maxFallbacks": 2
},
"allowProxyReuse": false,
"statistics": false,
"analytics": true
}
}03FAQ
Questions about API Key Settings.
01
Can I override the mode in API requests?
Yes, send settings.routing on the request (mode, provider, providerOrder) to override the key defaults.
02
Which value wins when the request and the key disagree?
The request, for that task only. A field the request leaves out takes the key's setting, and a setting never changed on the key takes the built-in default.