# Create agent

> POST https://api.nabrah.ai/api/ext/agent

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

Creates a new agent in the project tied to your API key and returns the full agent configuration, including the generated `agent_id`. An agent bundles the conversational persona (`who_are_you`, `goal`, `steps`), the speaking voice and languages, behavioral toggles (interruptions, ambient/thinking sounds), optional dynamic `variables`, webhook callbacks, and optional links to existing tools and analysis groups. Only `name` is conceptually essential; the remaining fields tune behavior and have sensible defaults. This is typically the first step in the workflow: create the agent, then create an analysis group, then link them.

## Key body fields

Field meanings as they appear in the request body.

- **Persona & conversation**: `name` is a human-readable label. `who_are_you` describes the agent's identity/persona, `goal` states what the call should accomplish, and `steps` outlines the procedure the agent should follow. `first_sentence` is the opening line and `start_first` controls whether the agent speaks first. Fields: `name`, `who_are_you`, `goal`, `steps`, `first_sentence`, `start_first`, `support_data`, `agent_type`.
- **Voice & language**: `voice` is a TTS voice ID — obtain valid values from GET /api/ext/tts/voices (e.g. "dania"). `languages` is the list of supported language codes (e.g. "ar", "en"). `language_mode` is "single" or "multi"; when multilingual, `dtmf_language_message` can prompt the caller to choose. `speech_speed` is a multiplier (e.g. 0.7–1.5) and `allow_interruptions` lets the caller barge in. Fields: `voice`, `languages`, `language_mode`, `dtmf_language_message`, `speech_speed`, `allow_interruptions`.
- **Audio ambience**: `background_ambient` plays subtle background audio and `background_ambient_volume` sets its level; `thinking_sound` plays a filler sound while the agent processes and `thinking_sound_volume` sets its level. Fields: `background_ambient`, `background_ambient_volume`, `thinking_sound`, `thinking_sound_volume`.
- **Tools, analysis groups & stack**: `tool_ids` links existing tools (IDs from GET /api/ext/tool) and `analysis_group_ids` links existing analysis groups (IDs from GET /api/ext/analysis) at creation time. `stack` selects the model/runtime stack (e.g. "latest"). Fields: `tool_ids`, `analysis_group_ids`, `stack`.
- **Dynamic variables**: `variables` are named placeholders the agent can reference at runtime; each has a `name`, a `type`, and a `default_value`. Fields: `variables`.
- **Webhook callbacks**: `pre_call_callback`, `post_call_callback`, and `post_analysis_callback` each define an outbound HTTP webhook with a `url` and a list of `parameters`. Each parameter has a `name`, a `location` (e.g. "header", "query", "body"), a `data_type`, and a `value`. Fields: `pre_call_callback`, `post_call_callback`, `post_analysis_callback`.

## Response

Returns the full AgentResponse with the new agent_id and resolved relations.

- **Capture the agent_id**: Store the returned `agent_id` — you need it to fetch, update, delete, or link analysis groups to this agent. The response also expands linked `tools`, `system_tools`, and `analysis_groups` so you can confirm the wiring.

A 422 response means the body failed validation; inspect `detail` for the offending field path.

## 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.

## Body (application/json)

### Example: Minimal

Smallest practical payload: an Arabic-speaking agent with a persona and goal.

```json
{
  "name": "Support Assistant",
  "start_first": true,
  "first_sentence": "مرحبًا، كيف يمكنني مساعدتك اليوم؟",
  "agent_type": "basic",
  "who_are_you": "You are Layla, a friendly customer support agent for Nabrah.",
  "goal": "Resolve the caller's billing question or hand off to a human if needed.",
  "steps": "1) Greet the caller. 2) Identify the issue. 3) Look up account details. 4) Offer a resolution.",
  "allow_interruptions": true,
  "voice": "dania",
  "languages": [
    "ar"
  ],
  "stack": "latest"
}
```

### Example: Full

All supported fields populated, including variables, callbacks, ambience, and links.

```json
{
  "name": "Premium Support Assistant",
  "start_first": true,
  "first_sentence": "Hello, you've reached Nabrah support. How can I help?",
  "agent_type": "basic",
  "who_are_you": "You are Layla, a calm and knowledgeable support agent for Nabrah.",
  "goal": "Diagnose the caller's issue, resolve it, and confirm satisfaction before ending the call.",
  "steps": "1) Greet. 2) Verify identity using {{customer_name}}. 3) Diagnose. 4) Resolve or escalate. 5) Confirm and close.",
  "allow_interruptions": true,
  "voice": "dania",
  "support_data": "Refund window is 14 days. Business hours are 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",
  "dtmf_language_message": "Press 1 for Arabic, press 2 for English."
}
```

## 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 POST \
  --url 'https://api.nabrah.ai/api/ext/agent' \
  --header 'X-API-Key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Support Assistant",
  "start_first": true,
  "first_sentence": "مرحبًا، كيف يمكنني مساعدتك اليوم؟",
  "agent_type": "basic",
  "who_are_you": "You are Layla, a friendly customer support agent for Nabrah.",
  "goal": "Resolve the caller'\''s billing question or hand off to a human if needed.",
  "steps": "1) Greet the caller. 2) Identify the issue. 3) Look up account details. 4) Offer a resolution.",
  "allow_interruptions": true,
  "voice": "dania",
  "languages": [
    "ar"
  ],
  "stack": "latest"
}'
```

### Python

```python
import requests

url = "https://api.nabrah.ai/api/ext/agent"
headers = {
    "X-API-Key": "<your-api-key>",
}
payload = {
    "name": "Support Assistant",
    "start_first": True,
    "first_sentence": "مرحبًا، كيف يمكنني مساعدتك اليوم؟",
    "agent_type": "basic",
    "who_are_you": "You are Layla, a friendly customer support agent for Nabrah.",
    "goal": "Resolve the caller's billing question or hand off to a human if needed.",
    "steps": "1) Greet the caller. 2) Identify the issue. 3) Look up account details. 4) Offer a resolution.",
    "allow_interruptions": True,
    "voice": "dania",
    "languages": [
        "ar"
    ],
    "stack": "latest"
}

response = requests.post(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", {
  method: "POST",
  headers: {
    "X-API-Key": "<your-api-key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Support Assistant",
    "start_first": true,
    "first_sentence": "مرحبًا، كيف يمكنني مساعدتك اليوم؟",
    "agent_type": "basic",
    "who_are_you": "You are Layla, a friendly customer support agent for Nabrah.",
    "goal": "Resolve the caller's billing question or hand off to a human if needed.",
    "steps": "1) Greet the caller. 2) Identify the issue. 3) Look up account details. 4) Offer a resolution.",
    "allow_interruptions": true,
    "voice": "dania",
    "languages": [
      "ar"
    ],
    "stack": "latest"
  }),
});

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",
  "start_first": true,
  "first_sentence": "مرحبًا، كيف يمكنني مساعدتك اليوم؟",
  "agent_type": "basic",
  "who_are_you": "You are Layla, a friendly customer support agent for Nabrah.",
  "goal": "Resolve the caller's billing question or hand off to a human if needed.",
  "steps": "1) Greet the caller. 2) Identify the issue. 3) Look up account details. 4) Offer a resolution.",
  "allow_interruptions": true,
  "voice": "dania",
  "languages": [
    "ar"
  ],
  "stack": "latest"
}`)

	req, _ := http.NewRequest("POST", "https://api.nabrah.ai/api/ext/agent", 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))
}
```