> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.awork.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.awork.com/_mcp/server.

# Disables a model, vendor, or region and updates settings that use it.

POST https://api.awork.com/api/v1/agents/models/settings/disable
Content-Type: application/json

Disables a model, vendor, or region for the workspace and updates settings that use it.
Use the model settings in the awork app to review affected configurations and eligible replacements before disabling.
Specify the required replacement models in the request. Returns no content when the changes are saved.The user must be an admin or have `workspace-manage-config:write` permissions.

Reference: https://developers.awork.com/apiv1/agent-runtime/post-agents-models-settings-disable

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects a DisableModelsRequestModel.

- `resourceType` (string, required) — The resource type: model, vendor, or region.
- `resourceKey` (string, required) — The resource key.
- `replacements` (list of ModelReplacementRequestModel, optional, nullable) — One replacement mapping for every affected source model.
- `presetReplacements` (list of ModelPresetReplacementRequestModel, optional, nullable) — One explicit replacement mapping for every affected preset.
- `confirmNoImageReplacement` (boolean, optional) — Whether disabling affected image models without a replacement was confirmed.

## Response

### 204

No Content

## Errors

### 400 Bad Request Error

Bad Request

- `code` (string, required) — The error code.
- `description` (string, required) — The description of the error.
- `link` (string, required) — The link to the API documentation page.
- `details` (list of string, optional, nullable) — A list of details describing the error.
- `validationErrors` (list of ValidationErrorResponse, optional, nullable) — If a validation error occurred, this contains the validation errors for each property.
- `traceId` (string, optional, nullable) — The request trace id for tracking the request.

### 401 Unauthorized Error

Unauthorized

- `code` (string, required) — The error code.
- `description` (string, required) — The description of the error.
- `link` (string, required) — The link to the API documentation page.
- `details` (list of string, optional, nullable) — A list of details describing the error.
- `validationErrors` (list of ValidationErrorResponse, optional, nullable) — If a validation error occurred, this contains the validation errors for each property.
- `traceId` (string, optional, nullable) — The request trace id for tracking the request.

## Types

### ModelReplacementRequestModel

Maps one source catalog model to one replacement catalog model.

- `sourceModelKey` (string, optional, nullable) — The affected source model key.
- `replacementModelKey` (string, optional, nullable) — The replacement model key, or null for a confirmed image capability removal.

### ModelPresetReplacementRequestModel

Maps one affected performance preset to an explicit replacement model.

- `presetKey` (string, optional, nullable) — The affected preset key.
- `replacementModelKey` (string, optional, nullable) — The replacement model key.

### ValidationErrorResponse

The validation error response.

- `property` (string, optional, nullable) — The name of the property that failed validation.
- `message` (string, optional, nullable) — The reason why this property failed validation.

## Examples

**Request**

```json
{
  "resourceType": "model",
  "resourceKey": "openai:gpt-5.6-terra"
}
```

**SDK Code**

```python
import requests

url = "https://api.awork.com/api/v1/agents/models/settings/disable"

payload = {
    "resourceType": "model",
    "resourceKey": "openai:gpt-5.6-terra"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.awork.com/api/v1/agents/models/settings/disable';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"resourceType":"model","resourceKey":"openai:gpt-5.6-terra"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.awork.com/api/v1/agents/models/settings/disable"

	payload := strings.NewReader("{\n  \"resourceType\": \"model\",\n  \"resourceKey\": \"openai:gpt-5.6-terra\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.awork.com/api/v1/agents/models/settings/disable")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"resourceType\": \"model\",\n  \"resourceKey\": \"openai:gpt-5.6-terra\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.awork.com/api/v1/agents/models/settings/disable")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"resourceType\": \"model\",\n  \"resourceKey\": \"openai:gpt-5.6-terra\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.awork.com/api/v1/agents/models/settings/disable', [
  'body' => '{
  "resourceType": "model",
  "resourceKey": "openai:gpt-5.6-terra"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.awork.com/api/v1/agents/models/settings/disable");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"resourceType\": \"model\",\n  \"resourceKey\": \"openai:gpt-5.6-terra\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "resourceType": "model",
  "resourceKey": "openai:gpt-5.6-terra"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.awork.com/api/v1/agents/models/settings/disable")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```