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

Folders

PreviousGet FoldersNextGet Folder Projects

Last updated 5 months ago

Summary of Endpoints

Get Folder Projects

Generate Agent in Folder

Create Agent in Folder

Get Folder Agents

Get Folder Medias

Get Folder Project Templates

⚙️
get

Get all projects in a folder, or in the home folder of a workspace.

Authorizations
Path parameters
folderIdstringRequired

Folder/Workspace/Space ID

Responses
200
Projects
application/json
4XX
Error description
application/json
get
GET /api/v1/folders/{folderId}/projects HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "items": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}
get

Get agents in a folder.

Authorizations
Path parameters
folderIdstringRequired
Query parameters
limitnumberOptionalDefault: 20
pagenumberOptionalDefault: 1
Responses
200
Agents
application/json
4XX
Error description
application/json
get
GET /api/v1/folders/{folderId}/agents HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "items": [
    {
      "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

Get medias in a folder

Authorizations
Path parameters
folderIdstringRequired
Query parameters
limitnumberOptionalDefault: 100
pagenumberOptionalDefault: 1
Responses
200
Medias
application/json
4XX
Error description
application/json
get
GET /api/v1/folders/{folderId}/medias HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "items": [
    {
      "id": "text",
      "space_id": "text",
      "kind": "text"
    }
  ]
}
get

Get projects templates in a folder.

Authorizations
Path parameters
folderIdstringRequired
Query parameters
limitnumberOptionalDefault: 20
pagenumberOptionalDefault: 1
Responses
200
Project Templates
application/json
4XX
Error description
application/json
get
GET /api/v1/folders/{folderId}/project-templates HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "items": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}
  • Summary of Endpoints
  • Get Folder Projects
  • GET/folders/{folderId}/projects
  • Generate Agent in Folder
  • POST/folders/{folderId}/agent-generate
  • Create Agent in Folder
  • POST/folders/{folderId}/agents
  • Get Folder Agents
  • GET/folders/{folderId}/agents
  • Get Folder Medias
  • GET/folders/{folderId}/medias
  • Get Folder Project Templates
  • GET/folders/{folderId}/project-templates
post

Generate agent based on input text prompts

Authorizations
Path parameters
folderIdstringRequired
Body
textstringRequired
Responses
200
Default response
application/json
4XX
Error description
application/json
post
POST /api/v1/folders/{folderId}/agent-generate HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "text": "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 an agent in a folder, or in the home folder of a workspace.

Authorizations
Path parameters
folderIdstringRequired
Body
namestringRequired
dataany ofRequired
or
Responses
200
Default response
application/json
4XX
Error description
application/json
post
POST /api/v1/folders/{folderId}/agents HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "name": "text",
  "data": {
    "type": "data",
    "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"
    }
  }
}