Agents

Summary of Endpoints

Update Agent Public Access

put

Enable public access in the agent

Authorizations

oAuthAuthorizationCodepersonalAccessToken

Path parameters

agentIdstringrequired

Responses

application/json

application/json

put

cURLJavaScriptPythonHTTP

curl -L \
  --request PUT \
  --url 'https://www.taskade.com/api/v1/agents/{agentId}/publicAccess'

200

4XX

200

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

Public access successfully enabled

Get Agent

get

Get agent with id

Authorizations

oAuthAuthorizationCodepersonalAccessToken

Path parameters

agentIdstringrequired

Responses

application/json

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url 'https://www.taskade.com/api/v1/agents/{agentId}'

200

4XX

200

{
  "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"
    }
  }
}

Agent

Delete Agent

delete

Delete an agent

Authorizations

oAuthAuthorizationCodepersonalAccessToken

Path parameters

agentIdstringrequired

Responses

application/json

application/json

delete

cURLJavaScriptPythonHTTP

curl -L \
  --request DELETE \
  --url 'https://www.taskade.com/api/v1/agents/{agentId}'

200

4XX

200

{
  "ok": true
}

Agent successfully deleted

Update Agent

patch

Update agent

Authorizations

oAuthAuthorizationCodepersonalAccessToken

Path parameters

agentIdstringrequired

Body

namestringoptional

dataobjectoptional

Responses

application/json

application/json

patch

cURLJavaScriptPythonHTTP

curl -L \
  --request PATCH \
  --url 'https://www.taskade.com/api/v1/agents/{agentId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

200

4XX

200

{
  "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"
    }
  }
}

Agent

Get Public Agent

get

Get public agent

Authorizations

oAuthAuthorizationCodepersonalAccessToken

Path parameters

agentIdstringrequired

Responses

application/json

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url 'https://www.taskade.com/api/v1/agents/{agentId}/public-agent'

200

4XX

200

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

Public Agent

Update Public Agent

patch

Update public agent

Authorizations

oAuthAuthorizationCodepersonalAccessToken

Path parameters

agentIdstringrequired

Body

preferencesobjectrequired

Responses

application/json

application/json

patch

cURLJavaScriptPythonHTTP

curl -L \
  --request PATCH \
  --url 'https://www.taskade.com/api/v1/agents/{agentId}/public-agent' \
  --header 'Content-Type: application/json' \
  --data '{
    "preferences": {
      "mode": "template",
      "canCopyKnowledge": true,
      "hideBranding": true,
      "theme": "light"
    }
  }'

200

4XX

200

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

Public Agent

Add Project to Agent Knowledge

post

Create a knowledge project

Authorizations

oAuthAuthorizationCodepersonalAccessToken

Path parameters

agentIdstringrequired

Body

projectIdstringrequired

Responses

application/json

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://www.taskade.com/api/v1/agents/{agentId}/knowledge/project' \
  --header 'Content-Type: application/json' \
  --data '{
    "projectId": "text"
  }'

200

4XX

200

{
  "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"
    }
  }
}

Project knowledge created

Add Media to Agent Knowledge

post

Create a knowledge media

Authorizations

oAuthAuthorizationCodepersonalAccessToken

Path parameters

agentIdstringrequired

Body

mediaIdstringrequired

Responses

application/json

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://www.taskade.com/api/v1/agents/{agentId}/knowledge/media' \
  --header 'Content-Type: application/json' \
  --data '{
    "mediaId": "text"
  }'

200

4XX

200

{
  "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"
    }
  }
}

Media knowledge created

Remove Project from Agent Knowledge

delete

Remove a knowledge project

Authorizations

oAuthAuthorizationCodepersonalAccessToken

Path parameters

agentIdstringrequired

projectIdstringrequired

Responses

application/json

application/json

delete

cURLJavaScriptPythonHTTP

curl -L \
  --request DELETE \
  --url 'https://www.taskade.com/api/v1/agents/{agentId}/knowledge/project/{projectId}'

200

4XX

200

{
  "ok": true
}

Project knowledge removed

Remove Media from Agent Knowledge

delete

Remove a knowledge media

Authorizations

oAuthAuthorizationCodepersonalAccessToken

Path parameters

agentIdstringrequired

mediaIdstringrequired

Responses

application/json

application/json

delete

cURLJavaScriptPythonHTTP

curl -L \
  --request DELETE \
  --url 'https://www.taskade.com/api/v1/agents/{agentId}/knowledge/media/{mediaId}'

200

4XX

200

{
  "ok": true
}

Media knowledge removed

Get Agent Conversations

get

Get agent conversations

Authorizations

oAuthAuthorizationCodepersonalAccessToken

Path parameters

agentIdstringrequired

Query parameters

limitnumberoptionalDefault: 20

pagenumberoptionalDefault: 1

Responses

application/json

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url 'https://www.taskade.com/api/v1/agents/{agentId}/convos/'

200

4XX

200

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

Agent conversations

Get Specific Agent Conversation

get

Get agent conversation by id

Authorizations

oAuthAuthorizationCodepersonalAccessToken

Path parameters

agentIdstringrequired

convoIdstringrequired

Responses

application/json

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url 'https://www.taskade.com/api/v1/agents/{agentId}/convos/{convoId}'

200

4XX

200

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

Agent conversation