Get Public Agent

Get Public Agent — Taskade REST API v1 reference: GET /agents/{agentId}/public-agent. Parameters, authentication, and response schema.

get

Get public agent

Authorizations

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

agentIdstringRequired

Responses

200

Public Agent

application/json

Public Agent

okboolean · enumRequiredPossible values:

publicUrlstring · uriRequired

4XX

Error description

application/json

get/agents/{agentId}/public-agent

GET /api/v1/agents/{agentId}/public-agent HTTP/1.1
Host: www.taskade.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ok": true,
  "item": {
    "id": "abc123DEF456",
    "name": "Sales Pipeline",
    "data": {
      "avatar": {
        "type": "custom",
        "data": {
          "file": {
            "ownerID": "abc123DEF456",
            "ownerType": "example",
            "id": "abc123DEF456",
            "namespace": "example",
            "extension": "example",
            "s3KeyOriginal": "example",
            "userID": 1,
            "spaceID": "abc123DEF456",
            "documentID": "abc123DEF456",
            "nodeID": "abc123DEF456",
            "size": 1,
            "mimetype": "image/png",
            "metadata": {},
            "type": "example",
            "name": "Sales Pipeline",
            "description": "Tracks deals from lead to close."
          }
        }
      },
      "conversationStarters": [
        {
          "id": "abc123DEF456",
          "text": "Follow up with client",
          "prompt": "Summarize the latest updates in this project."
        }
      ]
    },
    "preferences": {
      "mode": "template",
      "canCopyKnowledge": true,
      "hideBranding": true,
      "theme": "light",
      "autoEndChats": true,
      "meta": {
        "title": "Sales Pipeline",
        "description": "Tracks deals from lead to close.",
        "image": {
          "ownerID": "abc123DEF456",
          "ownerType": "example",
          "id": "abc123DEF456",
          "namespace": "example",
          "extension": "example",
          "s3KeyOriginal": "example",
          "userID": 1,
          "spaceID": "abc123DEF456",
          "documentID": "abc123DEF456",
          "nodeID": "abc123DEF456",
          "size": 1,
          "mimetype": "image/png",
          "metadata": {},
          "type": "example",
          "name": "Sales Pipeline",
          "description": "Tracks deals from lead to close."
        }
      },
      "color": "#4F46E5",
      "launcherIcon": {
        "type": "emoji",
        "value": "example"
      }
    }
  },
  "publicUrl": "https://example.com"
}