Tasks are the core work unit in profClaw. They are created from webhooks, the API, or the UI, queued for agent execution, and tracked through their lifecycle.Documentation Index
Fetch the complete documentation index at: https://docs.profclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
Task Status
GET /api/tasks
List tasks with optional status filter and pagination.| Param | Type | Description |
|---|---|---|
status | string | Filter by status |
limit | number | Max results (default 50) |
offset | number | Offset for pagination |
cursor | string | Cursor for cursor-based pagination (preferred) |
fields | string | Comma-separated sparse fieldset |
full | boolean | Return full objects (disables sparse fieldset) |
200
POST /api/tasks
Create a new task.CreateTaskSchema)
| Field | Type | Required | Notes |
|---|---|---|---|
title | string | Yes | |
description | string | No | |
prompt | string | No | Detailed instructions for the agent |
priority | number | No | 1 (critical) - 4 (low) |
source | string | No | github | jira | linear | api | cron |
sourceId | string | No | External ID |
sourceUrl | string | No | Link back to source |
repository | string | No | owner/repo |
branch | string | No | Git branch |
labels | string[] | No | |
assignedAgent | string | No | Force a specific adapter |
201: { "message": "Task created", "task": {...} }
GET /api/tasks/:id
Fetch a single task by ID.POST /api/tasks/:id/cancel
Cancel a pending or in-progress task.200: { "message": "Task cancelled", "task": {...} }
POST /api/tasks/:id/retry
Retry a failed or completed task. Creates a new task with the same parameters.200: { "message": "Task queued for retry", "task": {...}, "originalTaskId": "task_01" }
GET /api/tasks/:id/events
Retrieve the audit event log for a task (requiresstorage.getTaskEvents).
Advanced Filtering
status, priority, source, agent, labels, createdAfter, createdBefore, completedAfter, completedBefore, repository, q, sortBy, sortOrder
Analytics
Export / Import
Related
- Task Queue API - Inspect queue depth and manage dead-letter entries
- Agent Sessions API - Monitor task execution sessions
- profclaw task - Create and manage tasks from the CLI
- Webhooks API - Receive tasks from GitHub, Jira, and Linear