---
title: "Update public agent"
method: POST
path: "/updatePublicAgent"
tags: ["Agent"]
---

# Update public agent

`POST /updatePublicAgent`

## Request

- Base URL: `https://www.taskade.com/api/v2`
- URL: `https://www.taskade.com/api/v2/updatePublicAgent`
- Auth: OAuth 2 and HTTP bearer
  - Authorization code: `https://www.taskade.com/oauth2/authorize`
  - Token URL: `https://www.taskade.com/oauth2/token`

## Request body

- object
  - `agentId` string, required
  - `preferences` object, required
    - `mode` 'template' | 'chatbot'
    - `canCopyKnowledge` boolean
    - `hideBranding` boolean
    - `theme` 'light' | 'dark' | 'auto'
    - `autoEndChats` boolean
    - `meta` object
      - `title` string
      - `description` string
      - `image` object, nullable
        - `ownerID` string, required
        - `ownerType` string, nullable
        - `id` string, required
        - `namespace` string, required
        - `extension` string, required
        - `s3KeyOriginal` string, required
        - `userID` number, nullable
        - `spaceID` string, nullable
        - `documentID` string, nullable
        - `nodeID` string, nullable
        - `size` number, required
        - `mimetype` string, required
        - `metadata` object
        - `type` string
        - `name` string
        - `description` string
    - `color` string
    - `launcherIcon` union
      - object
        - `type` 'emoji', required
        - `value` string, required
      - object
        - `type` 'custom', required
        - `image` Image, required (unresolved $ref)
    - `widget` object, nullable
      - `mode` 'bubble' | 'modal' | 'sidebar'
      - `theme` object
        - `colorScheme` 'host'
        - `radius` 'none' | 'small' | 'medium' | 'large' | 'full'
        - `density` 'compact' | 'comfortable' | 'spacious'
        - `fontFamily` string
      - `popup` object
        - `position` 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'
        - `offset` integer
      - `launcher` object
        - `hidden` boolean
        - `size` 'sm' | 'md' | 'lg'
        - `label` string
        - `backgroundColor` string
      - `behavior` object
        - `autoOpenDelay` integer
        - `proactiveMessage` object
          - `text` string, required
      - `visibility` object
        - `revealAfterScroll` integer
        - `hidePaths` string[]
        - `mobile` 'hide'

## Response `200`

Default response

- object
  - `ok` true, required
  - `item` object, required
    - `id` string, required
    - `name` string, required
    - `data` object, required
      - `avatar` union
        - object
          - `type` 'custom', required
          - `data` object, required
            - `file` object, required
              - …
        - 0 (unresolved $ref)
      - `conversationStarters` object[]
        - `id` string, required
        - `text` string, required
        - `prompt` string
    - `preferences` object, required
      - `mode` 'template' | 'chatbot'
      - `canCopyKnowledge` boolean
      - `hideBranding` boolean
      - `theme` 'light' | 'dark' | 'auto'
      - `autoEndChats` boolean
      - `meta` object
        - `title` string
        - `description` string
        - `image` File (unresolved $ref)
      - `color` string
      - `launcherIcon` union
        - object
          - `type` 'emoji', required
          - `value` string, required
        - object
          - `type` 'custom', required
          - `image` File, required (unresolved $ref)
      - `widget` object, nullable
        - `mode` 'bubble' | 'modal' | 'sidebar'
        - `theme` object
          - `colorScheme` 'host'
          - `radius` 'none' | 'small' | 'medium' | 'large' | 'full'
          - `density` 'compact' | 'comfortable' | 'spacious'
          - `fontFamily` string
        - `popup` object
          - `position` 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'
          - `offset` integer
        - `launcher` object
          - `hidden` boolean
          - `size` 'sm' | 'md' | 'lg'
          - `label` string
          - `backgroundColor` string
        - `behavior` object
          - `autoOpenDelay` integer
          - `proactiveMessage` object
            - `text` string, required
        - `visibility` object
          - `revealAfterScroll` integer
          - `hidePaths` string[]
          - `mobile` 'hide'

---

[API](https://skmtc.dev/taskade/apis/taskade-public-api-v2.md) - [All operations](https://skmtc.dev/taskade/apis/taskade-public-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/taskade/apis/taskade-public-api-v2/revisions/45f0e74ec083?raw)