remove_ai_route
Remove an AI gateway alias; use force to delete it even when running apps still reference it as a gateway model.
Instructions
Remove a machine AI gateway alias (submitter or admin).
Refused with 409 ``ai_gateway.alias_in_use`` (naming the apps) while a
running app's ``[ai.*]`` uses it, unless ``force``.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"alias": "<alias>"
},
"name": "remove_ai_route"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| alias | Yes | Machine alias an app names in ``[ai.<name>] model`` with ``provider = "gateway"``: a lowercase letter, then up to 31 of a-z, 0-9, '_' or '-'. | |
| force | No | true = remove even while a running app uses the alias (its AI calls then fail with 404 ``alias_not_found``). | |
| idempotency_key | No | Caller-chosen key: a retry with the same key replays the first result instead of acting twice. Omit and a fresh key is minted per call, so each call acts. |