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

oAuthAuthorizationCode & personalAccessToken

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

HTTPcURLJavaScriptPython

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

{
  "ok": true,
  "item": {
    "id": "text",
    "name": "text",
    "data": {
      "avatar": {
        "type": "custom",
        "data": {
          "file": {
            "ownerID": "text",
            "ownerType": "text",
            "id": "text",
            "namespace": "text",
            "extension": "text",
            "s3KeyOriginal": "text",
            "userID": 1,
            "spaceID": "text",
            "documentID": "text",
            "nodeID": "text",
            "size": 1,
            "mimetype": "text",
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "type": "text",
            "name": "text",
            "description": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      },
      "conversationStarters": [
        {
          "id": "text",
          "text": "text",
          "prompt": "text"
        }
      ]
    },
    "preferences": {
      "mode": "template",
      "canCopyKnowledge": true,
      "hideBranding": true,
      "theme": "light",
      "autoEndChats": true,
      "meta": {
        "title": "text",
        "description": "text",
        "image": {}
      }
    }
  },
  "publicUrl": "https://example.com"
}