How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Taskfolk Agents API

The Agents API from Taskfolk — 5 operation(s) for agents.

Taskfolk Agents API is one of 32 APIs that Taskfolk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 7 operations across 5 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://taskfolk.ai/api.

7 operations 5 paths 5 schemas 4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://taskfolk.ai/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Taskfolk Agents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API key) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Workspace API key. Send as Authorization: Bearer tfklive…. Each key is bound to exactly one workspace and carries a set of scopes.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Agents 7
GET
/v1/workspaces/{slug}/agents
List the workspace's connected agents (named coding agents like Claude Code, Codex, Cursor). Assign issues to an agent's agentid like any member.
3 params → 200400401403404429
GET
/v1/workspaces/{slug}/agents/{id}
Get one agent's full profile: identity, owner, key state + scopes, field policy, spend cap, and cost + token totals. {id} is the agentid.
2 params → 200400401403404429
GET
/v1/workspaces/{slug}/agent-sessions
List agent work sessions, newest activity first. Filter by state to see which agents are running, blocked (needsinput), or ready for review.
6 params → 200400401403404429
POST
/v1/workspaces/{slug}/agent-sessions
Start an agent work session. Call this when you pick up an issue so the team can follow your progress on the ticket and the Agents hub.
1 param body → 201400401403404429
GET
/v1/workspaces/{slug}/agent-sessions/{id}
Get one agent session.
2 params → 200400401403404429
PATCH
/v1/workspaces/{slug}/agent-sessions/{id}
Update your session: heartbeat (any PATCH bumps lastactivityat), progress note, state change (needsinput when blocked, review when the PR is ready, done/failed to finish), or the PR link.
2 params body → 200400401403404429
POST
/v1/workspaces/{slug}/agent-sessions/{id}/usage
Report your token usage / cost for this session (one call per turn, additive). Send costusd from your provider, or send tokens + model and Taskfolk estimates the cost. Shows a live cost + burn rate n…
2 params body → 200400401403404429

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are AgentDetail (18 properties), AgentSession (18 properties), Agent (12 properties), ErrorEnvelope (1 property). Each schema is shown below with its type and property counts.

Pagination
object
1 property 1 required
AgentSession
object
18 properties 18 required
ErrorEnvelope
object
1 property 1 required
AgentDetail
object
18 properties 18 required
Agent
object
12 properties 12 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

taskfolk-agents-api-openapi.yml Raw ↑

Other APIs Taskfolk publishes across the network.

Taskfolk Activity API
Taskfolk Attachments API
Taskfolk Automations API
Taskfolk Chat API
Taskfolk Comments API
Taskfolk Custom fields API
Taskfolk Developer API
Taskfolk Docs API
Taskfolk Forms API
Taskfolk Goals API
Taskfolk Issues API
Taskfolk Key results API
Where this information came from

This is an independent, third-party profile of Taskfolk Agents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.