API Documentation

v1.1 Production

Last updated: April 2024

Power your AI agents and custom integrations with the TaskFlow API. Real-time updates, secure authentication, and AI-optimized context endpoints.

Getting Started

1. Authentication

Include your API key as a Bearer token in the Authorization header.

Authorization: Bearer YOUR_API_KEY

2. Request Example

curl -X GET \
  -H "Authorization: Bearer tf_..." \
  -H "Content-Type: application/json" \
  "https://taskflow.agent/api/v1/context"

Unified Response

All successful responses follow this structure:

{
  "success": true,
  "data": { ... },
  "meta": {
    "timestamp": "2024-04-15T...",
    "version": "1.1",
    "request_id": "req_8392..."
  }
}

PRO FEATURE

Proactive Webhook Engine

Don't poll, let TaskFlow call you. Our proactive sync engine notifies your agents immediately when tasks are updated, completed, or when new team members join.

Event Types

HMAC

Security

SIGNATURE VERIFICATION

const signature = crypto
  .createHmac('sha256', WEBHOOK_SECRET)
  .update(JSON.stringify(payload))
  .digest('hex');

if (signature === headers['x-taskflow-signature']) {
  // Valid payload
}

AI Context

GET

/api/v1/context

HTTPS

Get comprehensive workspace context optimized for AI agents. Includes active project status, team availability, and urgent priorities.

Response Object

{
  "projects": "Array of active projects with completion stats and ownership info",
  "members": "Full list of team members with roles and contact info",
  "urgent_tasks": "Top 10 overdue or urgent tasks across all projects",
  "recent_activity": "Latest 5 system-wide actions (created, updated, moved)",
  "whiteboards": "List of the 10 most recently updated brainstorming whiteboards",
  "system": {
    "current_time": "ISO 8601 timestamp",
    "ai_instructions": "Context-specific safety and privacy rules for the agent"
  }
}

Note: All date formats must follow ISO 8601 (YYYY-MM-DDTHH:MM:SSZ). Ensure proper URL encoding for query parameters.

Tasks

GET

/api/v1/tasks

HTTPS

List all tasks with advanced filtering and pagination.

Query Parameters

Name	Type	Description
project_id	uuid	Filter by project
status	string	todo, in_progress, review, done
assignee_id	uuid	Filter by assignee
priority	string	low, medium, high, urgent
due_before	datetime	Filter tasks due before this date
limit	number	Max results (default 20, max 100)
offset	number	Pagination offset

Response Object

Standard Resource Response

Note: All date formats must follow ISO 8601 (YYYY-MM-DDTHH:MM:SSZ). Ensure proper URL encoding for query parameters.

POST

/api/v1/tasks

HTTPS

Create a new task in a specific project.

JSON Body

Property	Type	Optional
project_id	uuid	No
milestone_id	uuid	Yes
title	string	No
description	string	Yes
priority	string	Yes
assignee_id	uuid	Yes
start_date	datetime	Yes
due_date	datetime	Yes
metadata	jsonb	Yes

Response Object

Standard Resource Response

Note: All date formats must follow ISO 8601 (YYYY-MM-DDTHH:MM:SSZ). Ensure proper URL encoding for query parameters.

GET

/api/v1/tasks/:id

HTTPS

Get full task details including project context and profiles.

PATCH

/api/v1/tasks/:id

HTTPS

Update task properties. Triggers 'task.updated' webhook.

JSON Body

Property	Type	Optional
title	string	Yes
status	string	Yes
assignee_id	uuid	Yes
metadata	jsonb	Yes

Response Object

Standard Resource Response

Note: All date formats must follow ISO 8601 (YYYY-MM-DDTHH:MM:SSZ). Ensure proper URL encoding for query parameters.

POST

/api/v1/tasks/:id/complete

HTTPS

Quick-complete a task. Moves status to 'done' and notifies team.

DELETE

/api/v1/tasks/:id

HTTPS

Permanently remove a task and its attachments.

Comments

GET

/api/v1/tasks/:id/comments

HTTPS

List all comments for a specific task.

POST

/api/v1/tasks/:id/comments

HTTPS

Add a new comment to a task. Triggers 'comment.added' webhook.

JSON Body

Property	Type	Optional
content	string	No

Response Object

Standard Resource Response

Note: All date formats must follow ISO 8601 (YYYY-MM-DDTHH:MM:SSZ). Ensure proper URL encoding for query parameters.

Meetings

GET

/api/v1/meetings

HTTPS

List all upcoming and past meetings where you are an organizer or participant.

Members & Team

GET

/api/v1/members

HTTPS

List all team members and clients in the workspace.

POST

/api/v1/members/invite

HTTPS

Invite a new member via email. Returns a shareable enrollment link.

JSON Body

Property	Type	Optional
email	string	No
full_name	string	No
role	string	No
phone_number	string	Yes

Response Object

Standard Resource Response

Note: All date formats must follow ISO 8601 (YYYY-MM-DDTHH:MM:SSZ). Ensure proper URL encoding for query parameters.

Webhooks (Proactive AI)

POST

YOUR_URL

HTTPS

TaskFlow pushes real-time updates to your configured URL. Security via HMAC-SHA256 signature.

Security Headers

X-TaskFlow-EventEvent type: task.created, task.updated, task.completed, comment.added, member.invited

X-TaskFlow-SignatureHMAC SHA256 signature for payload verification

Response Object

Standard Resource Response

Note: All date formats must follow ISO 8601 (YYYY-MM-DDTHH:MM:SSZ). Ensure proper URL encoding for query parameters.

System

GET

/api/v1/health

HTTPS

Production health check for monitoring and uptime tracking.

AI Agents Integration

Native OpenClaw Support

TaskFlow provides a native Skill definition file (SKILL.md) specifically designed for the OpenClaw AI framework.

If you are integrating an OpenClaw agent, there is no need to manually instruct it using this documentation page. We have prepared an optimized, native Skill file containing standard operating procedures, strict guidelines on handling internal vs client-facing events, and exact API schemas.

TaskFlow Manager Skill

Download and drop this file into your agent's workspace/skills/taskflow/ directory.

Download SKILL.md