# Update agent

> PUT https://api.nabrah.ai/api/ext/agent/{agent_id}

Group: Agents. Page: https://www.nabrah.ai/en/docs/api-reference/agents/update-agent

Updates the agent identified by `agent_id` and returns the full updated configuration. The body uses the same fields as agent creation; provide the values you want the agent to have. Note that `tool_ids` and `analysis_group_ids` set the agent's links — use them to attach or replace linked tools and analysis groups. For adding analysis-group links specifically, you can also use the dedicated linking endpoints. Fetch the agent first (GET /api/ext/agent/{agent_id}) if you need its current values before modifying.

## Where agent_id comes from

- **Discovering the ID**: Use GET /api/ext/agent to list agents, or the `agent_id` returned by POST /api/ext/agent.

## Field guidance

Body fields mirror Create Agent.

- **Voice & links**: `voice` must be a valid TTS voice ID from GET /api/ext/tts/voices. `tool_ids` (from GET /api/ext/tool) and `analysis_group_ids` (from GET /api/ext/analysis) define the agent's current links. The update body does not include `tool_ids`/`analysis_group_ids` in the response; the response instead expands the resolved `tools`, `system_tools`, and `analysis_groups`. Fields: `voice`, `tool_ids`, `analysis_group_ids`.

## Callback delivery

Callbacks are sent once and never retried.

- **pre_call_callback**: Called before each call, and before each chatbot reply on WhatsApp. Only an HTTP 200 JSON object is used; on any other response, an error or a timeout (10 seconds for calls, 30 seconds for WhatsApp) the conversation continues without those values. Fields: `pre_call_callback`.
- **post_call_callback** ({ "call_details": { "id", … } }): Sent once after a completed call, with a 30-second timeout. Calls that did not complete (for example no answer or busy) do not trigger it. Use `call_details.id` to deduplicate. Fields: `post_call_callback`.
- **post_analysis_callback**: Same payload, sent once after the call's analysis finishes. Fields: `post_analysis_callback`.
- **Authentication**: Callbacks are not signed. Add a secret header in `parameters` (location `header`) and check it on your side; `body` parameters are added to the JSON body.

## Authorization

- `X-API-Key` (string, header, required): your workspace API key.

## Path parameters

- `agent_id` (string, required): UUID of the agent to update. Get this from GET /api/ext/agent or from the create-agent response (POST /api/ext/agent).

## Body (application/json)

### Example: Rename & tune

Update the display name and core persona while keeping behavior simple.

```json
{
  "name": "Support Assistant (v2)",
  "start_first": true,
  "first_sentence": "Hi, thanks for calling Nabrah support. How can I help today?",
  "agent_type": "basic",
  "who_are_you": "You are Layla, a senior support agent for Nabrah.",
  "goal": "Resolve the caller's issue on the first call whenever possible.",
  "steps": "1) Greet. 2) Identify issue. 3) Resolve or escalate. 4) Confirm.",
  "allow_interruptions": true,
  "voice": "dania",
  "languages": [
    "ar",
    "en"
  ],
  "stack": "latest",
  "speech_speed": 1,
  "language_mode": "multi"
}
```

### Example: Full

All supported update fields populated.

```json
{
  "name": "Premium Support Assistant",
  "start_first": true,
  "first_sentence": "Hello, you've reached Nabrah support.",
  "agent_type": "basic",
  "who_are_you": "You are Layla, a calm and knowledgeable support agent for Nabrah.",
  "goal": "Diagnose, resolve, and confirm satisfaction before ending the call.",
  "steps": "1) Greet. 2) Verify with {{customer_name}}. 3) Diagnose. 4) Resolve or escalate. 5) Close.",
  "allow_interruptions": true,
  "voice": "dania",
  "support_data": "Refund window is 14 days. Business hours 9am-6pm GST.",
  "languages": [
    "ar",
    "en"
  ],
  "stack": "latest",
  "tool_ids": [
    "018f3a2b-9c4d-7e1a-bf52-0a1b2c3d4e5f"
  ],
  "analysis_group_ids": [
    "018f3a2b-1111-7e1a-bf52-0a1b2c3d4e5f"
  ],
  "speech_speed": 1,
  "variables": [
    {
      "name": "customer_name",
      "type": "string",
      "default_value": "valued customer"
    }
  ],
  "pre_call_callback": {
    "url": "https://example.com/hooks/pre-call",
    "parameters": [
      {
        "name": "Authorization",
        "location": "header",
        "data_type": "string",
        "value": "Bearer token123"
      }
    ]
  },
  "post_call_callback": {
    "url": "https://example.com/hooks/post-call",
    "parameters": [
      {
        "name": "call_id",
        "location": "body",
        "data_type": "string",
        "value": "{{call_id}}"
      }
    ]
  },
  "post_analysis_callback": {
    "url": "https://example.com/hooks/post-analysis",
    "parameters": [
      {
        "name": "X-Source",
        "location": "header",
        "data_type": "string",
        "value": "nabrah"
      }
    ]
  },
  "background_ambient": true,
  "background_ambient_volume": 0.2,
  "thinking_sound": true,
  "thinking_sound_volume": 0.3,
  "language_mode": "multi"
}
```

## Response

### 200 Successful Response

Content type: `application/json`

```json
{
  "agent_id": "00000000-0000-4000-8000-000000000000",
  "project_id": "00000000-0000-4000-8000-000000000000",
  "created_by_email": "string",
  "created_at": "2026-01-15T12:00:00.000Z",
  "last_update": "2026-01-15T12:00:00.000Z",
  "name": "string",
  "start_first": false,
  "first_sentence": "string",
  "agent_type": "basic",
  "who_are_you": "string",
  "goal": "string",
  "steps": "string",
  "allow_interruptions": false,
  "voice": "dania",
  "support_data": "string",
  "languages": [
    "ar"
  ],
  "stack": "latest",
  "speech_speed": 0.7,
  "variables": [
    {
      "name": "string",
      "type": "string",
      "default_value": "string"
    }
  ],
  "pre_call_callback": {
    "url": "string",
    "parameters": [
      {
        "name": "string",
        "location": "header",
        "data_type": "string",
        "value": "string"
      }
    ]
  },
  "post_call_callback": {
    "url": "string",
    "parameters": [
      {
        "name": "string",
        "location": "header",
        "data_type": "string",
        "value": "string"
      }
    ]
  },
  "post_analysis_callback": {
    "url": "string",
    "parameters": [
      {
        "name": "string",
        "location": "header",
        "data_type": "string",
        "value": "string"
      }
    ]
  },
  "tools": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "string"
    }
  ],
  "system_tools": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "string",
      "config": {},
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "when_to_use": "string"
    }
  ],
  "analysis_groups": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "string"
    }
  ],
  "background_ambient": false,
  "background_ambient_volume": 0,
  "thinking_sound": false,
  "thinking_sound_volume": 0,
  "language_mode": "single"
}
```

### 422 Validation Error

Content type: `application/json`

```json
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
```

## Request examples

### cURL

```bash
curl --request PUT \
  --url 'https://api.nabrah.ai/api/ext/agent/<agent_id>' \
  --header 'X-API-Key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Support Assistant (v2)",
  "start_first": true,
  "first_sentence": "Hi, thanks for calling Nabrah support. How can I help today?",
  "agent_type": "basic",
  "who_are_you": "You are Layla, a senior support agent for Nabrah.",
  "goal": "Resolve the caller'\''s issue on the first call whenever possible.",
  "steps": "1) Greet. 2) Identify issue. 3) Resolve or escalate. 4) Confirm.",
  "allow_interruptions": true,
  "voice": "dania",
  "languages": [
    "ar",
    "en"
  ],
  "stack": "latest",
  "speech_speed": 1,
  "language_mode": "multi"
}'
```

### Python

```python
import requests

url = "https://api.nabrah.ai/api/ext/agent/<agent_id>"
headers = {
    "X-API-Key": "<your-api-key>",
}
payload = {
    "name": "Support Assistant (v2)",
    "start_first": True,
    "first_sentence": "Hi, thanks for calling Nabrah support. How can I help today?",
    "agent_type": "basic",
    "who_are_you": "You are Layla, a senior support agent for Nabrah.",
    "goal": "Resolve the caller's issue on the first call whenever possible.",
    "steps": "1) Greet. 2) Identify issue. 3) Resolve or escalate. 4) Confirm.",
    "allow_interruptions": True,
    "voice": "dania",
    "languages": [
        "ar",
        "en"
    ],
    "stack": "latest",
    "speech_speed": 1,
    "language_mode": "multi"
}

response = requests.put(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.nabrah.ai/api/ext/agent/<agent_id>", {
  method: "PUT",
  headers: {
    "X-API-Key": "<your-api-key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Support Assistant (v2)",
    "start_first": true,
    "first_sentence": "Hi, thanks for calling Nabrah support. How can I help today?",
    "agent_type": "basic",
    "who_are_you": "You are Layla, a senior support agent for Nabrah.",
    "goal": "Resolve the caller's issue on the first call whenever possible.",
    "steps": "1) Greet. 2) Identify issue. 3) Resolve or escalate. 4) Confirm.",
    "allow_interruptions": true,
    "voice": "dania",
    "languages": [
      "ar",
      "en"
    ],
    "stack": "latest",
    "speech_speed": 1,
    "language_mode": "multi"
  }),
});

const data = await response.json();
console.log(data);
```

### Go

```go
package main

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

func main() {
	payload := strings.NewReader(`{
  "name": "Support Assistant (v2)",
  "start_first": true,
  "first_sentence": "Hi, thanks for calling Nabrah support. How can I help today?",
  "agent_type": "basic",
  "who_are_you": "You are Layla, a senior support agent for Nabrah.",
  "goal": "Resolve the caller's issue on the first call whenever possible.",
  "steps": "1) Greet. 2) Identify issue. 3) Resolve or escalate. 4) Confirm.",
  "allow_interruptions": true,
  "voice": "dania",
  "languages": [
    "ar",
    "en"
  ],
  "stack": "latest",
  "speech_speed": 1,
  "language_mode": "multi"
}`)

	req, _ := http.NewRequest("PUT", "https://api.nabrah.ai/api/ext/agent/<agent_id>", payload)
	req.Header.Set("X-API-Key", "<your-api-key>")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}
```