Model Routes

Update a model route

Updates a model route's name, targets, retry classes, or breaker configuration. Omitted fields are left unchanged.

put/v1/projects/{project_id}/model-routes/{route_id}

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/model-routes/{route_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Path parameters

route_idstring required

Model route ID

Request body

namestring

New name (unique per project)

retry_onstring[]
failure_thresholdinteger
cooldown_secondsinteger

Example request

{
  "targets": [
    {
      "ai_provider_id": "aip_V1StGXR8Z5jdHi6B",
      "model": "gpt-4o-mini",
      "timeout_seconds": 30,
      "max_retries": 1
    }
  ]
}

Response

Model route updated successfully

idstring
project_idstring
namestring
retry_onstring[]
failure_thresholdinteger
cooldown_secondsinteger
created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "route_V1StGXR8Z5jdHi6B",
  "name": "primary-with-fallback",
  "targets": [
    {
      "ai_provider_id": "aip_V1StGXR8Z5jdHi6B",
      "model": "gpt-4o-mini",
      "timeout_seconds": 30,
      "max_retries": 1
    }
  ],
  "failure_threshold": 3,
  "cooldown_seconds": 60
}

Changes

No recorded changes to this operation across all 1 revision of this API.