---
title: "Update AI Agent"
method: PUT
path: "/ai-agent/{id}"
tags: ["AI Agent"]
---

# Update AI Agent

`PUT /ai-agent/{id}`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/ai-agent/{id}`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/ai-agent/:id/put.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to update an existing AI Agent

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `data` AIAgentUpdateSchema, required: Update schema for AIAgent model. Update
    - `key` string: The secret the AI agent connects with, its AI_AGENT_KEY. Leave it out and OneUptime generates one. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `name` string: Any friendly name of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `aiAgentVersion` object: A version label for the AI agent. Leave it out and it is 1.0.0. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `iconFileId` string, uuid: AI Agent Icon File ID. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `isDefault` boolean: Is this the default AI Agent for the project? When set, this agent will be used for automated tasks. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `labels` object[]: Labels to group and filter by. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
      - `id` string

## Response `200`

Updated successfully

- object
  - `data` AIAgentReadSchema: Read schema for AIAgent model. Read
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `key` string: The secret the AI agent connects with, its AI_AGENT_KEY. Leave it out and OneUptime generates one. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `name` string, required: Any friendly name of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `slug` string: Friendly globally unique name for your object. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [No access - you don't have permission for this operation]
    - `aiAgentVersion` object: A version label for the AI agent. Leave it out and it is 1.0.0. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `lastAlive` object: When the AI agent last checked in. Set by OneUptime. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [No access - you don't have permission for this operation]
    - `iconFileId` string, uuid: AI Agent Icon File ID. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `projectId` string, uuid: ID of the project the AI agent belongs to. A global AI agent belongs to none. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [No access - you don't have permission for this operation]
    - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner], Update: [No access - you don't have permission for this operation]
    - `connectionStatus` 'connected' | 'disconnected': Connection Status of the AI Agent. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [No access - you don't have permission for this operation]
    - `isDefault` boolean: Is this the default AI Agent for the project? When set, this agent will be used for automated tasks. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
    - `labels` object[]: Labels to group and filter by. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create AI Agent], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read AI Agent], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit AI Agent]
      - `id` string

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)