Update account inference policy

http
PATCH /accounts/{account_id}/inference-policy

Update the models an account allows and denies and its default model, replacing each key sent; returns the policy. Requires account.settings.manage.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyAuth": []
  }
]
json
{
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "JWT or API Key",
    "description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
  },
  "apiKeyAuth": {
    "type": "apiKey",
    "in": "header",
    "name": "X-API-Key",
    "description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
  }
}

Parameters

NameLocationRequiredDescription
account_idpathYes

Parameter contracts

json
[
  {
    "schema": {
      "type": "string",
      "format": "uuid"
    },
    "required": true,
    "name": "account_id",
    "in": "path"
  }
]

Request body

json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "models": {
            "type": "object",
            "properties": {
              "allowed": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200,
                  "pattern": "^[a-z0-9][a-z0-9._/-]*$",
                  "description": "Model ID returned by list_models. Known catalog aliases are normalized to canonical IDs. Policy IDs use letters, digits, dots, underscores, slashes, and hyphens; arbitrary provider model strings are not accepted."
                },
                "maxItems": 500,
                "description": "Model IDs from list_models the account allows. Null removes the restriction; an empty list allows nothing. Omit to keep the stored list."
              },
              "denied": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200,
                  "pattern": "^[a-z0-9][a-z0-9._/-]*$",
                  "description": "Model ID returned by list_models. Known catalog aliases are normalized to canonical IDs. Policy IDs use letters, digits, dots, underscores, slashes, and hyphens; arbitrary provider model strings are not accepted."
                },
                "maxItems": 500,
                "description": "Model IDs from list_models the account denies. A denial overrides an allowance. Omit to keep the stored list."
              }
            },
            "additionalProperties": false,
            "description": "Models the account allows and denies. Every project of the account can only narrow them."
          },
          "default_model": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 200,
            "pattern": "^[a-z0-9][a-z0-9._/-]*$",
            "description": "Default model of projects that set none. It must be allowed by the policy. Null uses the built-in default. Omit to keep the stored value."
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses

200

The account inference policy after the update. Requires a signed-in account owner or admin. API keys are rejected regardless of their scopes.

json
{
  "description": "The account inference policy after the update. Requires a signed-in account owner or admin. API keys are rejected regardless of their scopes.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AccountInferencePolicy"
      }
    }
  }
}

400

Bad request

json
{
  "description": "Bad request",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

Unauthorized

json
{
  "description": "Unauthorized",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

403

Requires a signed-in session as the account owner or an admin with account.settings.manage. API keys are refused whatever their scopes, so no API key scope grants access.

json
{
  "description": "Requires a signed-in session as the account owner or an admin with `account.settings.manage`. API keys are refused whatever their scopes, so no API key scope grants access.",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

404

Not found

json
{
  "description": "Not found",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

422

A model in models.allowed or default_model is retired (model-retired). The Problem detail names its successor; nothing is saved.

json
{
  "description": "A model in `models.allowed` or `default_model` is retired (`model-retired`). The Problem detail names its successor; nothing is saved.",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

500

Server error

json
{
  "description": "Server error",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

Referenced contracts

components/schemas/AccountInferencePolicy

json
{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "format": "uuid"
    },
    "models": {
      "type": "object",
      "properties": {
        "allowed": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "Canonical model IDs that may be used. Null means no restriction; an empty list allows nothing."
        },
        "denied": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Canonical model IDs that may not be used. A denial overrides an allowance; an empty list denies nothing."
        }
      },
      "required": [
        "allowed",
        "denied"
      ],
      "description": "Models the account allows and denies. Every project of the account inherits them and can only narrow them."
    },
    "default_model": {
      "type": [
        "string",
        "null"
      ],
      "description": "Default model ID. Null uses the built-in default, mistral/mistral-small-2503. A project default wins over the account default."
    }
  },
  "required": [
    "account_id",
    "models",
    "default_model"
  ]
}

components/schemas/Problem

json
{
  "type": "object",
  "properties": {
    "cause": {
      "type": "string",
      "enum": [
        "schedule_concurrency_forbidden",
        "schedule_fire_in_progress",
        "schedule_run_limit_reached"
      ],
      "description": "Schedule admission refusal."
    },
    "idempotency": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "in_progress",
            "payload_mismatch",
            "outcome_unknown"
          ]
        },
        "operation": {
          "type": "string",
          "minLength": 1
        },
        "retryable": {
          "type": "boolean"
        },
        "retry_after_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "recovery": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "description": {
              "type": "string"
            },
            "resource_url": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "description"
          ]
        }
      },
      "required": [
        "state",
        "operation",
        "retryable",
        "retry_after_seconds",
        "expires_at"
      ],
      "description": "Replay status, retry timing, and recovery lookup."
    },
    "type": {
      "type": "string",
      "description": "URI reference identifying the problem type",
      "example": "https://api.veryfront.com/errors/validation-failed"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable summary of the problem",
      "example": "Validation Failed"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "description": "HTTP status code",
      "example": 400
    },
    "code": {
      "type": "string",
      "description": "Stable machine-readable error code",
      "example": "RUN_INVALID_INPUT"
    },
    "detail": {
      "type": "string",
      "description": "Human-readable explanation specific to this occurrence",
      "example": "The 'email' field must be a valid email address"
    },
    "instance": {
      "type": "string",
      "description": "URI reference identifying the specific occurrence",
      "example": "/projects/my-project/members"
    },
    "slug": {
      "type": "string",
      "description": "Stable identifier for the problem type",
      "example": "validation-failed"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTH",
        "RESOURCE",
        "VALIDATION",
        "DATABASE",
        "SUBSCRIPTION",
        "INTEGRATION",
        "INTERNAL"
      ],
      "description": "API error category",
      "example": "VALIDATION"
    },
    "suggestion": {
      "type": "string",
      "description": "Suggested action to resolve the problem",
      "example": "Check the request body and query parameters against the API documentation."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Field path that caused the error",
            "example": "email"
          },
          "message": {
            "type": "string",
            "description": "Error message for this field",
            "example": "Invalid email format"
          },
          "code": {
            "type": "string",
            "description": "Error code for this field",
            "example": "INVALID_FORMAT"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Detailed field-level errors for validation failures"
    }
  },
  "required": [
    "type",
    "title",
    "status"
  ]
}

Operation contract

json
{
  "operationId": "updateAccountInferencePolicy",
  "tags": [
    "ai-gateway/Models/Account inference policy"
  ],
  "summary": "Update account inference policy",
  "description": "Update the models an account allows and denies and its default model, replacing each key sent; returns the policy. Requires account.settings.manage.",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "required": true,
      "name": "account_id",
      "in": "path"
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "models": {
              "type": "object",
              "properties": {
                "allowed": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200,
                    "pattern": "^[a-z0-9][a-z0-9._/-]*$",
                    "description": "Model ID returned by list_models. Known catalog aliases are normalized to canonical IDs. Policy IDs use letters, digits, dots, underscores, slashes, and hyphens; arbitrary provider model strings are not accepted."
                  },
                  "maxItems": 500,
                  "description": "Model IDs from list_models the account allows. Null removes the restriction; an empty list allows nothing. Omit to keep the stored list."
                },
                "denied": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200,
                    "pattern": "^[a-z0-9][a-z0-9._/-]*$",
                    "description": "Model ID returned by list_models. Known catalog aliases are normalized to canonical IDs. Policy IDs use letters, digits, dots, underscores, slashes, and hyphens; arbitrary provider model strings are not accepted."
                  },
                  "maxItems": 500,
                  "description": "Model IDs from list_models the account denies. A denial overrides an allowance. Omit to keep the stored list."
                }
              },
              "additionalProperties": false,
              "description": "Models the account allows and denies. Every project of the account can only narrow them."
            },
            "default_model": {
              "type": [
                "string",
                "null"
              ],
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[a-z0-9][a-z0-9._/-]*$",
              "description": "Default model of projects that set none. It must be allowed by the policy. Null uses the built-in default. Omit to keep the stored value."
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "The account inference policy after the update. Requires a signed-in account owner or admin. API keys are rejected regardless of their scopes.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AccountInferencePolicy"
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "403": {
      "description": "Requires a signed-in session as the account owner or an admin with `account.settings.manage`. API keys are refused whatever their scopes, so no API key scope grants access.",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "404": {
      "description": "Not found",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "422": {
      "description": "A model in `models.allowed` or `default_model` is retired (`model-retired`). The Problem detail names its successor; nothing is saved.",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Account inference policy",
  "x-canonical-documentation": {
    "domain": "ai-gateway",
    "resource": "Models",
    "subgroup": "Account inference policy",
    "name": "Update account inference policy",
    "description": "Update the models an account allows and denies and its default model, replacing each key sent; returns the policy. Requires account.settings.manage.",
    "operationId": "updateAccountInferencePolicy"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/ai-gateway-models-account-inference-policy/update-account-inference-policy"
  }
}