---
title: "PATCH /api/v1/projects/{projectUuid}/aiAgents/{agentUuid}"
method: PATCH
path: "/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}"
---

# PATCH /api/v1/projects/{projectUuid}/aiAgents/{agentUuid}

`PATCH /api/v1/projects/{projectUuid}/aiAgents/{agentUuid}`

## Path parameters

- `projectUuid` string, required
- `agentUuid` string, required

## Request body

- ApiUpdateAiAgent — Make all properties in T optional
  - `name` string
  - `description` string, nullable
  - `projectUuid` string
  - `version` number, double
  - `userAccess` string[]
  - `integrations` object[]
    - `channelId` string, required
    - `type` 'slack', required
  - `tags` string[], nullable
  - `instruction` string, nullable
  - `imageUrl` string, nullable
  - `groupAccess` string[]
  - `spaceAccess` string[]
  - `enableDataAccess` boolean
  - `enableSelfImprovement` boolean
  - `enableContentTools` boolean
  - `enableUserContext` boolean
  - `adminOnly` boolean
  - `modelConfig` AiAgentModelConfig
    - `reasoning` boolean
    - `modelProvider` string, required
    - `modelName` string, required
  - `mcpServerUuids` string[]
  - `uuid` string, required

## Response `200`

Success

- ApiAiAgentResponse
  - `results` AiAgent, required — From T, pick a set of properties whose keys are in the union K
    - `name` string, required
    - `description` string, nullable, required
    - `uuid` string, required
    - `organizationUuid` string, required
    - `projectUuid` string, required
    - `updatedAt` string, date-time, required
    - `version` number, double, required
    - `createdAt` string, date-time, required
    - `userAccess` string[], required
    - `integrations` object[], required
      - `channelId` string, required
      - `type` 'slack', required
    - `tags` string[], nullable, required
    - `instruction` string, nullable, required
    - `imageUrl` string, nullable, required
    - `imageUrlSource` 'url' | 'upload' | 'null', nullable, required
    - `groupAccess` string[], required
    - `spaceAccess` string[], required
    - `enableDataAccess` boolean, required
    - `enableSelfImprovement` boolean, required
    - `enableContentTools` boolean, required
    - `enableUserContext` boolean, required
    - `adminOnly` boolean, required
    - `modelConfig` AiAgentModelConfig, required
      - `reasoning` boolean
      - `modelProvider` string, required
      - `modelName` string, required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.net/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.net/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/versions/40c933755c9a/schema)