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

# Edit an expert

PATCH https://api.rydhm.ai/v1/agents/{id}
Content-Type: application/json

Send only the fields to change. `baseUpdatedAt` (the `updatedAt` you loaded) makes the save refuse with 409 stale_edit when someone saved in between.

Needs the experts:write scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Reference: https://docs.rydhm.ai/api-reference/experts/update

## Authentication

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

## Request

### Path parameters

- `id` (string, required) — The expert id.

### Body (application/json)

This endpoint expects an object.

- `name` (string, optional)
- `description` (string, optional)
- `personaPrompt` (string, optional) — May use \{\{variables}}.
- `firstMessage` (string, optional)
- `voiceConfig` (map from string to any, optional) — Engine, model, voice and experience settings.
- `toolPolicy` (map from string to any, optional) — Per-tool policy overrides.
- `baseUpdatedAt` (datetime, optional)

## Response

### 200

OK

- `id` (string, required) — A UUID.
- `orgId` (string, required) — A UUID.
- `name` (string, required)
- `personaPrompt` (string, required)
- `isActive` (boolean, required)
- `visibility` (enum, required)
  - Allowed values: `private`, `unlisted`, `public`
- `createdAt` (datetime, required)
- `updatedAt` (datetime, required)
- `description` (string, optional, nullable)
- `firstMessage` (string, optional, nullable)
- `avatarUrl` (string, optional, nullable)
- `backgroundUrl` (string, optional, nullable)
- `voiceConfig` (map from string to any, optional) — Engine, model, voice and experience settings.
- `toolPolicy` (map from string to any, optional) — Per-tool policy overrides.
- `slug` (string, optional, nullable)
- `publishedAt` (datetime, optional, nullable)
- `widgetConfig` (map from string to any, optional) — Website widget appearance.
- `interopConfig` (map from string to any, optional) — MCP servers and hand-off specialists; secrets masked.

## Errors

### 401 Unauthorized Error

The key is missing, not valid, disabled or expired (error: invalid_api_key, api_key_disabled, api_key_expired).

- `statusCode` (integer, required)
- `message` (string, required)
- `error` (string, optional) — A stable code such as insufficient_scope, expert_not_allowed, rate_limited, plan_limit, payment_required.
- `code` (string, optional) — The stable code on the refusals that carry it here instead of in `error`: stale_edit (409 on an expert save).
- `requestId` (string, optional) — The X-Request-Id of the call, to quote to support.
- `upgradeHint` (ErrorUpgradeHint, optional) — On 402 payment_required and 403 plan_limit: what fixes it.
- `requiredScopes` (list of string, optional) — On 403 insufficient_scope: what the route needs.
- `missingScopes` (list of string, optional)
- `retryAfterSeconds` (integer, optional) — On 429: how long to wait.

### 403 Forbidden Error

The key lacks a scope (insufficient_scope), may not use this expert (expert_not_allowed), or the route is session-only (not_available_to_api_keys).

- `statusCode` (integer, required)
- `message` (string, required)
- `error` (string, optional) — A stable code such as insufficient_scope, expert_not_allowed, rate_limited, plan_limit, payment_required.
- `code` (string, optional) — The stable code on the refusals that carry it here instead of in `error`: stale_edit (409 on an expert save).
- `requestId` (string, optional) — The X-Request-Id of the call, to quote to support.
- `upgradeHint` (ErrorUpgradeHint, optional) — On 402 payment_required and 403 plan_limit: what fixes it.
- `requiredScopes` (list of string, optional) — On 403 insufficient_scope: what the route needs.
- `missingScopes` (list of string, optional)
- `retryAfterSeconds` (integer, optional) — On 429: how long to wait.

### 409 Conflict Error

Someone saved in between: the body’s `code` is stale_edit. Reload and try again.

- `statusCode` (integer, required)
- `message` (string, required)
- `error` (string, optional) — A stable code such as insufficient_scope, expert_not_allowed, rate_limited, plan_limit, payment_required.
- `code` (string, optional) — The stable code on the refusals that carry it here instead of in `error`: stale_edit (409 on an expert save).
- `requestId` (string, optional) — The X-Request-Id of the call, to quote to support.
- `upgradeHint` (ErrorUpgradeHint, optional) — On 402 payment_required and 403 plan_limit: what fixes it.
- `requiredScopes` (list of string, optional) — On 403 insufficient_scope: what the route needs.
- `missingScopes` (list of string, optional)
- `retryAfterSeconds` (integer, optional) — On 429: how long to wait.

### 429 Too Many Requests Error

Rate limited; wait Retry-After seconds.

- `statusCode` (integer, required)
- `message` (string, required)
- `error` (string, optional) — A stable code such as insufficient_scope, expert_not_allowed, rate_limited, plan_limit, payment_required.
- `code` (string, optional) — The stable code on the refusals that carry it here instead of in `error`: stale_edit (409 on an expert save).
- `requestId` (string, optional) — The X-Request-Id of the call, to quote to support.
- `upgradeHint` (ErrorUpgradeHint, optional) — On 402 payment_required and 403 plan_limit: what fixes it.
- `requiredScopes` (list of string, optional) — On 403 insufficient_scope: what the route needs.
- `missingScopes` (list of string, optional)
- `retryAfterSeconds` (integer, optional) — On 429: how long to wait.

## Types

### ErrorUpgradeHint

On 402 payment_required and 403 plan_limit: what fixes it.

- `action` (enum, optional)
  - Allowed values: `top_up`, `upgrade`, `contact`
- `planCode` (string, optional) — The smallest plan that allows it, when action is upgrade.
- `href` (string, optional) — Where to go in the app.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "id": "string",
  "orgId": "string",
  "name": "string",
  "personaPrompt": "string",
  "isActive": true,
  "visibility": "private",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "description": "string",
  "firstMessage": "string",
  "avatarUrl": "string",
  "backgroundUrl": "string",
  "voiceConfig": {},
  "toolPolicy": {},
  "slug": "string",
  "publishedAt": "2024-01-15T09:30:00Z",
  "widgetConfig": {},
  "interopConfig": {}
}
```

**SDK Code**

```python
import requests

url = "https://api.rydhm.ai/v1/agents/id"

payload = {}
headers = {
    "Authorization": "Bearer <apiKey>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.rydhm.ai/v1/agents/id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

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