Taskade API
TaskadeChangelogDocumentation
  • Introduction
  • 👋Getting Started
    • Personal Tokens
    • OAuth 2.0 Authentication
  • 🤖TaskOS (Coming Soon)
    • Introduction
  • ⚙️API reference
    • Workspaces
      • Get Workspaces
      • Get Projects
      • Get Folders
    • Folders
      • Get Folder Projects
      • Generate Agent in Folder
      • Create Agent in Folder
      • Get Folder Agents
      • Get Folder Medias
      • Get Folder Project Templates
    • Projects
      • Get Project
      • Complete Project
      • Restore Project
      • Copy Project
      • Create Project
      • Create From Template
      • Get Project Members
      • Get Project Fields
      • Get Project Tasks
      • Get Project Block
      • Get Share Link
      • Update Share Link
    • Tasks
      • Create Task
      • Get Task
      • Update Task
      • Move Task
      • Complete Task
      • Uncomplete Task
      • Delete Task
      • Get Task Assignees
      • Update Task Assignees
      • Delete Task Assignees
      • Get Task Date
      • Update Task Date
      • Delete Task Date
      • Get Task Note
      • Update Task Note
      • Delete Task Note
      • Get Task Field
      • Update Task Field
      • Delete Task Field
    • Agents
      • Get Agent
      • Delete Agent
      • Update Agent
      • Get Public Agent
      • Update Public Agent
      • Update Agent Public Access
      • Add Project to Knowledge
      • Add Media to Knowledge
      • Remove Project from Knowledge
      • Remove Media from Knowledge
      • Get Conversations
      • Get Conversation
      • Inbound Webhooks
    • Media
      • Get Media
      • Delete Media
    • Me
      • Get Projects
    • Specifications
  • 🔗Links
    • Taskade
    • Changelog
    • Documentation
    • Community Forum
Powered by GitBook
On this page
  1. API reference

Agents

PreviousDelete Task FieldNextGet Agent

Last updated 5 months ago

Summary of Endpoints

Update Agent Public Access

Get Agent

Delete Agent

Update Agent

Get Public Agent

Update Public Agent

Add Project to Agent Knowledge

Add Media to Agent Knowledge

Remove Project from Agent Knowledge

Remove Media from Agent Knowledge

Get Agent Conversations

Get Specific Agent Conversation

⚙️
put

Enable public access in the agent

Authorizations
Path parameters
agentIdstringRequired
Responses
200
Public access successfully enabled
application/json
4XX
Error description
application/json
put
PUT /api/v1/agents/{agentId}/publicAccess HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "publicUrl": "https://example.com"
}
get

Get agent with id

Authorizations
Path parameters
agentIdstringRequired
Responses
200
Agent
application/json
4XX
Error description
application/json
get
GET /api/v1/agents/{agentId} HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "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": true,
      "language": "text"
    }
  }
}
delete

Delete an agent

Authorizations
Path parameters
agentIdstringRequired
Responses
200
Agent successfully deleted
application/json
4XX
Error description
application/json
delete
DELETE /api/v1/agents/{agentId} HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true
}
get

Get public agent

Authorizations
Path parameters
agentIdstringRequired
Responses
200
Public Agent
application/json
4XX
Error description
application/json
get
GET /api/v1/agents/{agentId}/public-agent HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "id": "text",
    "space_agent_id": "text",
    "preferences": {
      "mode": "template",
      "canCopyKnowledge": true,
      "hideBranding": true,
      "theme": "light"
    }
  },
  "publicUrl": "https://example.com"
}
delete

Remove a knowledge project

Authorizations
Path parameters
agentIdstringRequired
projectIdstringRequired
Responses
200
Project knowledge removed
application/json
4XX
Error description
application/json
delete
DELETE /api/v1/agents/{agentId}/knowledge/project/{projectId} HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true
}
delete

Remove a knowledge media

Authorizations
Path parameters
agentIdstringRequired
mediaIdstringRequired
Responses
200
Media knowledge removed
application/json
4XX
Error description
application/json
delete
DELETE /api/v1/agents/{agentId}/knowledge/media/{mediaId} HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true
}
get

Get agent conversations

Authorizations
Path parameters
agentIdstringRequired
Query parameters
limitnumberOptionalDefault: 20
pagenumberOptionalDefault: 1
Responses
200
Agent conversations
application/json
4XX
Error description
application/json
get
GET /api/v1/agents/{agentId}/convos/ HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "items": [
    {
      "id": "text",
      "space_agent_id": "text",
      "status": "in_progress",
      "title": "text",
      "data": {
        "llm": {
          "type": "openai",
          "name": "gpt-3.5-turbo"
        }
      }
    }
  ]
}
get

Get agent conversation by id

Authorizations
Path parameters
agentIdstringRequired
convoIdstringRequired
Responses
200
Agent conversation
application/json
4XX
Error description
application/json
get
GET /api/v1/agents/{agentId}/convos/{convoId} HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "id": "text",
    "space_agent_id": "text",
    "status": "in_progress",
    "title": "text",
    "data": {
      "llm": {
        "type": "openai",
        "name": "gpt-3.5-turbo"
      }
    }
  }
}
  • Summary of Endpoints
  • Update Agent Public Access
  • PUT/agents/{agentId}/publicAccess
  • Get Agent
  • GET/agents/{agentId}
  • Delete Agent
  • DELETE/agents/{agentId}
  • Update Agent
  • PATCH/agents/{agentId}
  • Get Public Agent
  • GET/agents/{agentId}/public-agent
  • Update Public Agent
  • PATCH/agents/{agentId}/public-agent
  • Add Project to Agent Knowledge
  • POST/agents/{agentId}/knowledge/project
  • Add Media to Agent Knowledge
  • POST/agents/{agentId}/knowledge/media
  • Remove Project from Agent Knowledge
  • DELETE/agents/{agentId}/knowledge/project/{projectId}
  • Remove Media from Agent Knowledge
  • DELETE/agents/{agentId}/knowledge/media/{mediaId}
  • Get Agent Conversations
  • GET/agents/{agentId}/convos/
  • Get Specific Agent Conversation
  • GET/agents/{agentId}/convos/{convoId}
patch

Update agent

Authorizations
Path parameters
agentIdstringRequired
Body
namestringOptional
Responses
200
Agent
application/json
4XX
Error description
application/json
patch
PATCH /api/v1/agents/{agentId} HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 234

{
  "name": "text",
  "data": {
    "commands": [
      {
        "name": "text",
        "prompt": "text",
        "id": "text",
        "mode": "default"
      }
    ],
    "description": "text",
    "tone": "authoritative",
    "avatar": {
      "type": "emoji",
      "data": {
        "value": "text"
      }
    },
    "knowledgeEnabled": true,
    "language": "text"
  }
}
{
  "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": true,
      "language": "text"
    }
  }
}
patch

Update public agent

Authorizations
Path parameters
agentIdstringRequired
Body
Responses
200
Public Agent
application/json
4XX
Error description
application/json
patch
PATCH /api/v1/agents/{agentId}/public-agent HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 95

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

Create a knowledge project

Authorizations
Path parameters
agentIdstringRequired
Body
projectIdstringRequired
Responses
200
Project knowledge created
application/json
4XX
Error description
application/json
post
POST /api/v1/agents/{agentId}/knowledge/project HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "projectId": "text"
}
{
  "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": true,
      "language": "text"
    }
  }
}
post

Create a knowledge media

Authorizations
Path parameters
agentIdstringRequired
Body
mediaIdstringRequired
Responses
200
Media knowledge created
application/json
4XX
Error description
application/json
post
POST /api/v1/agents/{agentId}/knowledge/media HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "mediaId": "text"
}
{
  "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": true,
      "language": "text"
    }
  }
}