---
title: "Add a New Agent"
method: POST
path: "/v1/workspaces/{workspace_id}/agents"
tags: ["Agents"]
---

# Add a New Agent

`POST /v1/workspaces/{workspace_id}/agents`

## Request

- Base URL: `https://api.oxvo.com`
- URL: `https://api.oxvo.com/v1/workspaces/{workspace_id}/agents`
- Auth: API key in header `api_access_token`

Add a new Agent to Account

## Request body

- AgentCreatePayload
  - `name` string, required: Full Name of the agent
  - `email` string, required: Email of the Agent
  - `role` 'agent' | 'administrator', required: Whether its administrator or agent
  - `availability_status` 'available' | 'busy' | 'offline': The availability setting of the agent.
  - `auto_offline` boolean: Whether the availability status of agent is configured to go offline automatically when away.

## Response `200`

Success

- Agent
  - `id` integer
  - `account_id` integer
  - `availability_status` 'available' | 'busy' | 'offline': The availability status of the agent computed by OXVO.
  - `auto_offline` boolean: Whether the availability status of agent is configured to go offline automatically when away.
  - `confirmed` boolean: Whether the agent has confirmed their email address.
  - `email` string: The email of the agent
  - `available_name` string: The available name of the agent
  - `name` string: The name of the agent
  - `role` 'agent' | 'administrator': The role of the agent
  - `thumbnail` string: The thumbnail of the agent
  - `custom_role_id` integer, nullable: The custom role id of the agent

## Other responses

- `403`: Access denied

---

[API](https://skmtc.dev/oxvo/apis/oxvo-apis.md) · [All operations](https://skmtc.dev/oxvo/apis/oxvo-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/oxvo/apis/oxvo-apis/revisions/9a8448cbd1fe?raw)