Agents

Summary of Endpoints

Update Agent Public Access

Enable public access in the agent

PUThttps://www.taskade.com/api/v1/agents/{agentId}/publicAccess

Path parameters

agentId*string

Response

2004XX

Public access successfully enabled

Body

application/json

ok*enum

true

publicUrl*string (uri)

Request

JavaScriptCurlPython

const response = await fetch('https://www.taskade.com/api/v1/agents/{agentId}/publicAccess', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

2004XX

{
  "ok": true,
  "publicUrl": "https://example.com"
}

Get Agent

Get agent with id

GEThttps://www.taskade.com/api/v1/agents/{agentId}

Path parameters

agentId*string

Response

2004XX

Agent

Body

application/json

ok*enum

true

item*nullable all of

Request

JavaScriptCurlPython

const response = await fetch('https://www.taskade.com/api/v1/agents/{agentId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

2004XX

{
  "ok": true,
  "item": {
    "id": "text",
    "name": "text",
    "space_id": "text",
    "data": {
      "commands": [
        {
          "name": "text",
          "prompt": "text",
          "id": "text",
          "mode": "default"
        }
      ],
      "description": "text",
      "tone": "authoritative",
      "avatar": {
        "type": "emoji",
        "data": {
          "value": "text"
        }
      },
      "knowledgeEnabled": false,
      "language": "text"
    }
  }
}

Delete Agent

Delete an agent

DELETEhttps://www.taskade.com/api/v1/agents/{agentId}

Path parameters

agentId*string

Response

2004XX

Agent successfully deleted

Body

application/json

ok*enum

true

Request

JavaScriptCurlPython

const response = await fetch('https://www.taskade.com/api/v1/agents/{agentId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

2004XX

{
  "ok": true
}

Update Agent

Update agent

PATCHhttps://www.taskade.com/api/v1/agents/{agentId}

Path parameters

agentId*string

Body

application/json

namestring

datadata (object)

Response

2004XX

Agent

Body

application/json

ok*enum

true

item*nullable all of

Request

JavaScriptCurlPython

const response = await fetch('https://www.taskade.com/api/v1/agents/{agentId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

2004XX

{
  "ok": true,
  "item": {
    "id": "text",
    "name": "text",
    "space_id": "text",
    "data": {
      "commands": [
        {
          "name": "text",
          "prompt": "text",
          "id": "text",
          "mode": "default"
        }
      ],
      "description": "text",
      "tone": "authoritative",
      "avatar": {
        "type": "emoji",
        "data": {
          "value": "text"
        }
      },
      "knowledgeEnabled": false,
      "language": "text"
    }
  }
}

Get Public Agent

Get public agent

GEThttps://www.taskade.com/api/v1/agents/{agentId}/public-agent

Path parameters

agentId*string

Response

2004XX

Public Agent

Body

application/json

ok*enum

true

item*object

publicUrl*string (uri)

Request

JavaScriptCurlPython

const response = await fetch('https://www.taskade.com/api/v1/agents/{agentId}/public-agent', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

2004XX

{
  "ok": true,
  "item": {
    "id": "text",
    "space_agent_id": "text",
    "preferences": {
      "mode": "template",
      "canCopyKnowledge": false,
      "hideBranding": false,
      "theme": "light"
    }
  },
  "publicUrl": "https://example.com"
}

Update Public Agent

Update public agent

PATCHhttps://www.taskade.com/api/v1/agents/{agentId}/public-agent

Path parameters

agentId*string

Body

application/json

preferences*object

Response

2004XX

Public Agent

Body

application/json

ok*enum

true

item*object

Request

JavaScriptCurlPython

const response = await fetch('https://www.taskade.com/api/v1/agents/{agentId}/public-agent', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "preferences": {}
    }),
});
const data = await response.json();

Response

2004XX

{
  "ok": true,
  "item": {
    "id": "text",
    "space_agent_id": "text",
    "preferences": {
      "mode": "template",
      "canCopyKnowledge": false,
      "hideBranding": false,
      "theme": "light"
    }
  }
}

Add Project to Agent Knowledge

Create a knowledge project

POSThttps://www.taskade.com/api/v1/agents/{agentId}/knowledge/project

Path parameters

agentId*string

Body

application/json

projectId*string

Response

2004XX

Project knowledge created

Body

application/json

ok*enum

true

item*SpaceAgent (object)

Request

JavaScriptCurlPython

const response = await fetch('https://www.taskade.com/api/v1/agents/{agentId}/knowledge/project', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "projectId": "text"
    }),
});
const data = await response.json();

Response

2004XX

{
  "ok": true,
  "item": {
    "id": "text",
    "name": "text",
    "space_id": "text",
    "data": {
      "commands": [
        {
          "name": "text",
          "prompt": "text",
          "id": "text",
          "mode": "default"
        }
      ],
      "description": "text",
      "tone": "authoritative",
      "avatar": {
        "type": "emoji",
        "data": {
          "value": "text"
        }
      },
      "knowledgeEnabled": false,
      "language": "text"
    }
  }
}

Add Media to Agent Knowledge

Create a knowledge media

POSThttps://www.taskade.com/api/v1/agents/{agentId}/knowledge/media

Path parameters

agentId*string

Body

application/json

mediaId*string

Response

2004XX

Media knowledge created

Body

application/json

ok*enum

true

item*SpaceAgent (object)

Request

JavaScriptCurlPython

const response = await fetch('https://www.taskade.com/api/v1/agents/{agentId}/knowledge/media', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "mediaId": "text"
    }),
});
const data = await response.json();

Response

2004XX

{
  "ok": true,
  "item": {
    "id": "text",
    "name": "text",
    "space_id": "text",
    "data": {
      "commands": [
        {
          "name": "text",
          "prompt": "text",
          "id": "text",
          "mode": "default"
        }
      ],
      "description": "text",
      "tone": "authoritative",
      "avatar": {
        "type": "emoji",
        "data": {
          "value": "text"
        }
      },
      "knowledgeEnabled": false,
      "language": "text"
    }
  }
}

Remove Project from Agent Knowledge

Remove a knowledge project

DELETEhttps://www.taskade.com/api/v1/agents/{agentId}/knowledge/project/{projectId}

Path parameters

agentId*string

projectId*string

Response

2004XX

Project knowledge removed

Body

application/json

ok*enum

true

Request

JavaScriptCurlPython

const response = await fetch('https://www.taskade.com/api/v1/agents/{agentId}/knowledge/project/{projectId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

2004XX

{
  "ok": true
}

Remove Media from Agent Knowledge

Remove a knowledge media

DELETEhttps://www.taskade.com/api/v1/agents/{agentId}/knowledge/media/{mediaId}

Path parameters

agentId*string

mediaId*string

Response

2004XX

Media knowledge removed

Body

application/json

ok*enum

true

Request

JavaScriptCurlPython

const response = await fetch('https://www.taskade.com/api/v1/agents/{agentId}/knowledge/media/{mediaId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

2004XX

{
  "ok": true
}

Get Agent Conversations

Get agent conversations

GEThttps://www.taskade.com/api/v1/agents/{agentId}/convos/

Path parameters

agentId*string

Query parameters

Response

2004XX

Agent conversations

Body

application/json

ok*enum

true

items*array of Convo (object)

Request

JavaScriptCurlPython

const response = await fetch('https://www.taskade.com/api/v1/agents/{agentId}/convos/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

2004XX

{
  "ok": true,
  "items": [
    {
      "id": "text",
      "space_agent_id": "text",
      "status": "in_progress",
      "title": "text",
      "data": {
        "llm": {
          "type": "openai",
          "name": "gpt-3.5-turbo"
        }
      }
    }
  ]
}

Get Specific Agent Conversation

Get agent conversation by id

GEThttps://www.taskade.com/api/v1/agents/{agentId}/convos/{convoId}

Path parameters

agentId*string

convoId*string

Response

2004XX

Agent conversation

Body

application/json

ok*enum

true

item*Convo (object)

Request

JavaScriptCurlPython

const response = await fetch('https://www.taskade.com/api/v1/agents/{agentId}/convos/{convoId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

2004XX

{
  "ok": true,
  "item": {
    "id": "text",
    "space_agent_id": "text",
    "status": "in_progress",
    "title": "text",
    "data": {
      "llm": {
        "type": "openai",
        "name": "gpt-3.5-turbo"
      }
    }
  }
}