---
title: "GET /agents/{agentId}/public-agent"
method: GET
path: "/agents/{agentId}/public-agent"
tags: ["Agent"]
---

# GET /agents/{agentId}/public-agent

`GET /agents/{agentId}/public-agent`

## Request

- Base URL: `https://www.taskade.com/api/v1`
- URL: `https://www.taskade.com/api/v1/agents/{agentId}/public-agent`
- Auth: OAuth 2 and HTTP bearer
  - Authorization code: `https://www.taskade.com/oauth2/authorize`
  - Token URL: `https://www.taskade.com/oauth2/token`

Get public agent

## Path parameters

- `agentId` string, required

## Response `200`

Public Agent

- object: Public Agent
  - `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'
  - `publicUrl` string, uri, required

## Other responses

- `4XX`: Error description

---

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