---
title: "Update a Specific AI Agent by ID"
method: PUT
path: "/v1/ai-agents/{agent_id}"
tags: ["Agents"]
---

# Update a Specific AI Agent by ID

`PUT /v1/ai-agents/{agent_id}`

Update a Specific AI Agent by ID

## Path parameters

- `agent_id` string, required — ID of the agent

## Request body

- AIAgentInput
  - `name` string, required — Name of the AI agent
  - `imageUrl` string, required — Image URL for the AI agent
  - `mission` Mission
    - `prompt` string, nullable — Full prompt instructions for LLM model
    - `objective` string, nullable — Objective of the mission
    - `greeting` string, nullable, required — Greeting message to be read by the AI agent
    - `sequence` Sequence[], nullable — Sequence of actions to be performed by the AI agent during the conversation.
      - `stageName` string, required — Name of the stage
      - `description` string, required — Description of the stage
      - `otherNotes` string, nullable — Other notes that AI agent should know in this stage of conversation
    - `farewell` string, nullable — Conclusion message to be read by the AI agent
  - `status` 'active' | 'inactive', required
  - `role` string, required — Role of the AI agent in the company
  - `roleDescription` string, required — Description of the role of the AI agent
  - `timezone` string, required — Timezone of the AI agent used for scheduling meetings
  - `voice` VoiceInput
    - `gender` 'Male' | 'Female' | 'Neutral', required
    - `languageAccent` LanguageAccentCombo, required
      - `language` 'English' | 'Spanish' | 'Hindi', required
      - `accent` 'American' | 'Indian' | 'Australian' | 'British' | 'Hindi', required
    - `modelId` string, required

## Response `200`

AI Agent updated successfully

- AIAgentOutput — AI agent configured by businesses
  - `id` string
  - `orgId` string
  - `name` string
  - `imageUrl` string
  - `mission` Mission
    - `prompt` string, nullable — Full prompt instructions for LLM model
    - `objective` string, nullable — Objective of the mission
    - `greeting` string, nullable, required — Greeting message to be read by the AI agent
    - `sequence` Sequence[], nullable — Sequence of actions to be performed by the AI agent during the conversation.
      - `stageName` string, required — Name of the stage
      - `description` string, required — Description of the stage
      - `otherNotes` string, nullable — Other notes that AI agent should know in this stage of conversation
    - `farewell` string, nullable — Conclusion message to be read by the AI agent
  - `role` string
  - `roleDescription` string
  - `transcriber` Transcriber
    - `providerName` string
    - `transcriberModel` string, nullable
    - `providerProps` object, nullable
  - `intelligenceProvider` IntelligenceProvider
    - `providerName` string, nullable
    - `model` string, nullable
    - `providerProps` object, nullable
  - `voice` VoiceOutput
    - `gender` 'Male' | 'Female' | 'Neutral', required
    - `languageAccent` LanguageAccentCombo, required
      - `language` 'English' | 'Spanish' | 'Hindi', required
      - `accent` 'American' | 'Indian' | 'Australian' | 'British' | 'Hindi', required
    - `modelId` string, required
  - `status` string
  - `timezone` string
  - `createdBy` string
  - `createdAt` string, date-time
  - `updatedBy` string
  - `updatedAt` string, date-time

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/tratahq/apis/trata-ai-api.md) · [All operations](https://skmtc.net/tratahq/apis/trata-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tratahq/trata-ai-api/revisions/8f7b69ee5a90/schema)