AI Agents

The Intelligence Layer is the brain of your application. It's where reasoning, logic, and autonomous action take place. This layer is powered by Taskade's AI Agents.

An Agent is more than just a chatbot. It is an autonomous worker that can be configured with a specific personality, skillset, and access to knowledge. You can use Agents to:

Power a Chatbot: Provide intelligent, context-aware answers to user queries based on the app's Knowledge Layer.
Execute Complex Tasks: Trigger agents via automations to perform multi-step operations like analyzing data, qualifying leads, or summarizing documents.
Collaborate with Humans: Assign tasks to agents and have them work alongside your team members within a project.

These endpoints allow you to create, manage, and interact with the AI Agents that bring your applications to life.

Learn More

Summary of Endpoints

Update Agent Public Access

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Get Agent

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
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 Agent

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "ok": true
}

Update Agent

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
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"
    }
  }
}

Get Public Agent

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Update Public Agent

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
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"
    }
  }
}

Add Project to Agent Knowledge

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
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"
    }
  }
}

Add Media to Agent Knowledge

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
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"
    }
  }
}

Remove Project from Agent Knowledge

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "ok": true
}

Remove Media from Agent Knowledge

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "ok": true
}

Get Agent Conversations

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
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 Specific Agent Conversation

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
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

PreviousDelete Task Field NextGet Agent

Last updated 8 days ago