agent-swarm.devagent-swarm.dev

Tasks

Core task API — create, assign, update, and monitor tasks across the swarm

GET
/api/paused-tasks

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Response Body

application/json

curl -X GET "http://localhost:3013/api/paused-tasks"
{
  "tasks": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "key": "string",
      "agentId": "string",
      "creatorAgentId": "string",
      "task": "string",
      "title": "string",
      "status": "backlog",
      "source": "mcp",
      "taskType": "string",
      "tags": [],
      "priority": 50,
      "dependsOn": [],
      "offeredTo": "string",
      "offeredAt": "2019-08-24T14:15:22Z",
      "acceptedAt": "2019-08-24T14:15:22Z",
      "rejectionReason": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "lastUpdatedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "notifiedAt": "2019-08-24T14:15:22Z",
      "failureReason": "string",
      "output": "string",
      "progress": "string",
      "slackChannelId": "string",
      "slackThreadTs": "string",
      "slackTriggerMessageTs": "string",
      "slackUserId": "string",
      "slackReplySent": false,
      "slackProgressMessageTs": "string",
      "slackTreeRootMessageTs": "string",
      "vcsProvider": "github",
      "vcsRepo": "string",
      "vcsEventType": "string",
      "vcsNumber": 0,
      "vcsCommentId": 0,
      "vcsAuthor": "string",
      "vcsUrl": "string",
      "vcsInstallationId": 0,
      "vcsNodeId": "string",
      "agentmailInboxId": "string",
      "agentmailMessageId": "string",
      "agentmailThreadId": "string",
      "mentionMessageId": "string",
      "mentionChannelId": "string",
      "dir": "string",
      "parentTaskId": "string",
      "claudeSessionId": "string",
      "model": "string",
      "modelTier": "smol",
      "effort": "off",
      "scheduleId": "string",
      "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
      "workflowRunStepId": "87990b6e-ec5d-4b37-8b4e-9ef25c331b99",
      "contextKey": "string",
      "outputSchema": {
        "property1": null,
        "property2": null
      },
      "followUpConfig": {
        "disabled": true,
        "onCompleted": "string",
        "onFailed": "string"
      },
      "wasPaused": false,
      "compactionCount": 0,
      "peakContextPercent": 100,
      "peakContextTokens": 0,
      "contextWindowSize": 0,
      "credentialKeySuffix": "string",
      "credentialKeyType": "string",
      "requestedByUserId": "string",
      "swarmVersion": "string",
      "provider": "claude",
      "providerMeta": {
        "property1": null,
        "property2": null
      },
      "harnessVariant": "string",
      "harnessVariantMeta": {
        "property1": null,
        "property2": null
      },
      "totalCostUsd": 0,
      "routingAffinity": {
        "sourceAgentId": "string",
        "role": "string",
        "harnessProvider": "claude",
        "capabilities": []
      }
    }
  ]
}
GET
/api/steering-messages

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Query Parameters

taskId?string

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/steering-messages"
{
  "messages": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
      "body": "string",
      "mode": "steer",
      "status": "pending",
      "deliveredMode": "steer",
      "source": "ui",
      "createdByKind": "user",
      "createdByUserId": "string",
      "createdByAgentId": "string",
      "promotedTaskId": "eccfaabc-92d6-4fa5-818c-c7d655a8e358",
      "createdAt": "2019-08-24T14:15:22Z",
      "deliveredAt": "2019-08-24T14:15:22Z",
      "handledAt": "2019-08-24T14:15:22Z",
      "handledNote": "string"
    }
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/steering-messages/{id}/delivered

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/steering-messages/string/delivered" \  -H "Content-Type: application/json" \  -d '{    "mode": "steer"  }'
{
  "message": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
    "body": "string",
    "mode": "steer",
    "status": "pending",
    "deliveredMode": "steer",
    "source": "ui",
    "createdByKind": "user",
    "createdByUserId": "string",
    "createdByAgentId": "string",
    "promotedTaskId": "eccfaabc-92d6-4fa5-818c-c7d655a8e358",
    "createdAt": "2019-08-24T14:15:22Z",
    "deliveredAt": "2019-08-24T14:15:22Z",
    "handledAt": "2019-08-24T14:15:22Z",
    "handledNote": "string"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/steering-messages/{id}/handled

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/steering-messages/string/handled"
{
  "message": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
    "body": "string",
    "mode": "steer",
    "status": "pending",
    "deliveredMode": "steer",
    "source": "ui",
    "createdByKind": "user",
    "createdByUserId": "string",
    "createdByAgentId": "string",
    "promotedTaskId": "eccfaabc-92d6-4fa5-818c-c7d655a8e358",
    "createdAt": "2019-08-24T14:15:22Z",
    "deliveredAt": "2019-08-24T14:15:22Z",
    "handledAt": "2019-08-24T14:15:22Z",
    "handledNote": "string"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/steering-messages/{id}/undeliverable

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/steering-messages/string/undeliverable" \  -H "Content-Type: application/json" \  -d '{    "reason": "string"  }'
{
  "message": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
    "body": "string",
    "mode": "steer",
    "status": "pending",
    "deliveredMode": "steer",
    "source": "ui",
    "createdByKind": "user",
    "createdByUserId": "string",
    "createdByAgentId": "string",
    "promotedTaskId": "eccfaabc-92d6-4fa5-818c-c7d655a8e358",
    "createdAt": "2019-08-24T14:15:22Z",
    "deliveredAt": "2019-08-24T14:15:22Z",
    "handledAt": "2019-08-24T14:15:22Z",
    "handledNote": "string"
  },
  "promotedTaskId": "string"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/tasks

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Query Parameters

status?string
agentId?string
scheduleId?string
key?string

Non-unique asset directory namespace (for example shared/ or personal//drafts/). Runtime write boundaries normalize and validate the canonical form.

Length1 <= length <= 255
keyPrefix?string

Non-unique asset directory namespace (for example shared/ or personal//drafts/). Runtime write boundaries normalize and validate the canonical form.

Length1 <= length <= 255
search?string
includeHeartbeat?string
Value in"true" | "false"
createdAfter?string
Formatdate-time
createdBefore?string
Formatdate-time
source?string
requestedByUserId?string
Length1 <= length
orderBy?string
Value in"lastUpdatedAt" | "createdAt"
limit?|
offset?|
fields?string
Value in"full" | "slim"

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/tasks"
{
  "tasks": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "key": "string",
      "agentId": "string",
      "creatorAgentId": "string",
      "task": "string",
      "title": "string",
      "status": "backlog",
      "source": "mcp",
      "taskType": "string",
      "tags": [],
      "priority": 50,
      "dependsOn": [],
      "offeredTo": "string",
      "offeredAt": "2019-08-24T14:15:22Z",
      "acceptedAt": "2019-08-24T14:15:22Z",
      "rejectionReason": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "lastUpdatedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "notifiedAt": "2019-08-24T14:15:22Z",
      "failureReason": "string",
      "output": "string",
      "progress": "string",
      "slackChannelId": "string",
      "slackThreadTs": "string",
      "slackTriggerMessageTs": "string",
      "slackUserId": "string",
      "slackReplySent": false,
      "slackProgressMessageTs": "string",
      "slackTreeRootMessageTs": "string",
      "vcsProvider": "github",
      "vcsRepo": "string",
      "vcsEventType": "string",
      "vcsNumber": 0,
      "vcsCommentId": 0,
      "vcsAuthor": "string",
      "vcsUrl": "string",
      "vcsInstallationId": 0,
      "vcsNodeId": "string",
      "agentmailInboxId": "string",
      "agentmailMessageId": "string",
      "agentmailThreadId": "string",
      "mentionMessageId": "string",
      "mentionChannelId": "string",
      "dir": "string",
      "parentTaskId": "string",
      "claudeSessionId": "string",
      "model": "string",
      "modelTier": "smol",
      "effort": "off",
      "scheduleId": "string",
      "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
      "workflowRunStepId": "87990b6e-ec5d-4b37-8b4e-9ef25c331b99",
      "contextKey": "string",
      "outputSchema": {
        "property1": null,
        "property2": null
      },
      "followUpConfig": {
        "disabled": true,
        "onCompleted": "string",
        "onFailed": "string"
      },
      "wasPaused": false,
      "compactionCount": 0,
      "peakContextPercent": 100,
      "peakContextTokens": 0,
      "contextWindowSize": 0,
      "credentialKeySuffix": "string",
      "credentialKeyType": "string",
      "requestedByUserId": "string",
      "swarmVersion": "string",
      "provider": "claude",
      "providerMeta": {
        "property1": null,
        "property2": null
      },
      "harnessVariant": "string",
      "harnessVariantMeta": {
        "property1": null,
        "property2": null
      },
      "totalCostUsd": 0,
      "routingAffinity": {
        "sourceAgentId": "string",
        "role": "string",
        "harnessProvider": "claude",
        "capabilities": []
      }
    }
  ],
  "total": 0
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/tasks

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "http://localhost:3013/api/tasks" \  -H "Content-Type: application/json" \  -d '{    "task": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "key": "string",
  "agentId": "string",
  "creatorAgentId": "string",
  "task": "string",
  "title": "string",
  "status": "backlog",
  "source": "mcp",
  "taskType": "string",
  "tags": [],
  "priority": 50,
  "dependsOn": [],
  "offeredTo": "string",
  "offeredAt": "2019-08-24T14:15:22Z",
  "acceptedAt": "2019-08-24T14:15:22Z",
  "rejectionReason": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastUpdatedAt": "2019-08-24T14:15:22Z",
  "finishedAt": "2019-08-24T14:15:22Z",
  "notifiedAt": "2019-08-24T14:15:22Z",
  "failureReason": "string",
  "output": "string",
  "progress": "string",
  "slackChannelId": "string",
  "slackThreadTs": "string",
  "slackTriggerMessageTs": "string",
  "slackUserId": "string",
  "slackReplySent": false,
  "slackProgressMessageTs": "string",
  "slackTreeRootMessageTs": "string",
  "vcsProvider": "github",
  "vcsRepo": "string",
  "vcsEventType": "string",
  "vcsNumber": 0,
  "vcsCommentId": 0,
  "vcsAuthor": "string",
  "vcsUrl": "string",
  "vcsInstallationId": 0,
  "vcsNodeId": "string",
  "agentmailInboxId": "string",
  "agentmailMessageId": "string",
  "agentmailThreadId": "string",
  "mentionMessageId": "string",
  "mentionChannelId": "string",
  "dir": "string",
  "parentTaskId": "string",
  "claudeSessionId": "string",
  "model": "string",
  "modelTier": "smol",
  "effort": "off",
  "scheduleId": "string",
  "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
  "workflowRunStepId": "87990b6e-ec5d-4b37-8b4e-9ef25c331b99",
  "contextKey": "string",
  "outputSchema": {
    "property1": null,
    "property2": null
  },
  "followUpConfig": {
    "disabled": true,
    "onCompleted": "string",
    "onFailed": "string"
  },
  "wasPaused": false,
  "compactionCount": 0,
  "peakContextPercent": 100,
  "peakContextTokens": 0,
  "contextWindowSize": 0,
  "credentialKeySuffix": "string",
  "credentialKeyType": "string",
  "requestedByUserId": "string",
  "swarmVersion": "string",
  "provider": "claude",
  "providerMeta": {
    "property1": null,
    "property2": null
  },
  "harnessVariant": "string",
  "harnessVariantMeta": {
    "property1": null,
    "property2": null
  },
  "totalCostUsd": 0,
  "routingAffinity": {
    "sourceAgentId": "string",
    "role": "string",
    "harnessProvider": "claude",
    "capabilities": []
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/tasks/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Query Parameters

logsLimit?integer
Range1 <= value <= 1000

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/tasks/string"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "key": "string",
  "agentId": "string",
  "creatorAgentId": "string",
  "task": "string",
  "title": "string",
  "status": "backlog",
  "source": "mcp",
  "taskType": "string",
  "tags": [],
  "priority": 50,
  "dependsOn": [],
  "offeredTo": "string",
  "offeredAt": "2019-08-24T14:15:22Z",
  "acceptedAt": "2019-08-24T14:15:22Z",
  "rejectionReason": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastUpdatedAt": "2019-08-24T14:15:22Z",
  "finishedAt": "2019-08-24T14:15:22Z",
  "notifiedAt": "2019-08-24T14:15:22Z",
  "failureReason": "string",
  "output": "string",
  "progress": "string",
  "slackChannelId": "string",
  "slackThreadTs": "string",
  "slackTriggerMessageTs": "string",
  "slackUserId": "string",
  "slackReplySent": false,
  "slackProgressMessageTs": "string",
  "slackTreeRootMessageTs": "string",
  "vcsProvider": "github",
  "vcsRepo": "string",
  "vcsEventType": "string",
  "vcsNumber": 0,
  "vcsCommentId": 0,
  "vcsAuthor": "string",
  "vcsUrl": "string",
  "vcsInstallationId": 0,
  "vcsNodeId": "string",
  "agentmailInboxId": "string",
  "agentmailMessageId": "string",
  "agentmailThreadId": "string",
  "mentionMessageId": "string",
  "mentionChannelId": "string",
  "dir": "string",
  "parentTaskId": "string",
  "claudeSessionId": "string",
  "model": "string",
  "modelTier": "smol",
  "effort": "off",
  "scheduleId": "string",
  "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
  "workflowRunStepId": "87990b6e-ec5d-4b37-8b4e-9ef25c331b99",
  "contextKey": "string",
  "outputSchema": {
    "property1": null,
    "property2": null
  },
  "followUpConfig": {
    "disabled": true,
    "onCompleted": "string",
    "onFailed": "string"
  },
  "wasPaused": false,
  "compactionCount": 0,
  "peakContextPercent": 100,
  "peakContextTokens": 0,
  "contextWindowSize": 0,
  "credentialKeySuffix": "string",
  "credentialKeyType": "string",
  "requestedByUserId": "string",
  "swarmVersion": "string",
  "provider": "claude",
  "providerMeta": {
    "property1": null,
    "property2": null
  },
  "harnessVariant": "string",
  "harnessVariantMeta": {
    "property1": null,
    "property2": null
  },
  "totalCostUsd": 0,
  "routingAffinity": {
    "sourceAgentId": "string",
    "role": "string",
    "harnessProvider": "claude",
    "capabilities": []
  },
  "isLeadTask": true,
  "supportedSteerModes": [
    "steer"
  ],
  "logs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "eventType": "agent_joined",
      "agentId": "string",
      "taskId": "string",
      "oldValue": "string",
      "newValue": "string",
      "metadata": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "attachments": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
      "agentId": "string",
      "name": "string",
      "kind": "agent-fs",
      "url": "string",
      "path": "string",
      "pageId": "string",
      "providerId": "string",
      "providerKey": "string",
      "capabilities": {
        "property1": null,
        "property2": null
      },
      "orgId": "string",
      "driveId": "string",
      "mimeType": "string",
      "sizeBytes": 0,
      "sha256": "string",
      "intent": "string",
      "description": "string",
      "isPrimary": false,
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "updatedBy": "string"
    }
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/tasks/{id}/cancel

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/tasks/string/cancel"
{
  "success": true,
  "task": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "key": "string",
    "agentId": "string",
    "creatorAgentId": "string",
    "task": "string",
    "title": "string",
    "status": "backlog",
    "source": "mcp",
    "taskType": "string",
    "tags": [],
    "priority": 50,
    "dependsOn": [],
    "offeredTo": "string",
    "offeredAt": "2019-08-24T14:15:22Z",
    "acceptedAt": "2019-08-24T14:15:22Z",
    "rejectionReason": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "lastUpdatedAt": "2019-08-24T14:15:22Z",
    "finishedAt": "2019-08-24T14:15:22Z",
    "notifiedAt": "2019-08-24T14:15:22Z",
    "failureReason": "string",
    "output": "string",
    "progress": "string",
    "slackChannelId": "string",
    "slackThreadTs": "string",
    "slackTriggerMessageTs": "string",
    "slackUserId": "string",
    "slackReplySent": false,
    "slackProgressMessageTs": "string",
    "slackTreeRootMessageTs": "string",
    "vcsProvider": "github",
    "vcsRepo": "string",
    "vcsEventType": "string",
    "vcsNumber": 0,
    "vcsCommentId": 0,
    "vcsAuthor": "string",
    "vcsUrl": "string",
    "vcsInstallationId": 0,
    "vcsNodeId": "string",
    "agentmailInboxId": "string",
    "agentmailMessageId": "string",
    "agentmailThreadId": "string",
    "mentionMessageId": "string",
    "mentionChannelId": "string",
    "dir": "string",
    "parentTaskId": "string",
    "claudeSessionId": "string",
    "model": "string",
    "modelTier": "smol",
    "effort": "off",
    "scheduleId": "string",
    "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
    "workflowRunStepId": "87990b6e-ec5d-4b37-8b4e-9ef25c331b99",
    "contextKey": "string",
    "outputSchema": {
      "property1": null,
      "property2": null
    },
    "followUpConfig": {
      "disabled": true,
      "onCompleted": "string",
      "onFailed": "string"
    },
    "wasPaused": false,
    "compactionCount": 0,
    "peakContextPercent": 100,
    "peakContextTokens": 0,
    "contextWindowSize": 0,
    "credentialKeySuffix": "string",
    "credentialKeyType": "string",
    "requestedByUserId": "string",
    "swarmVersion": "string",
    "provider": "claude",
    "providerMeta": {
      "property1": null,
      "property2": null
    },
    "harnessVariant": "string",
    "harnessVariantMeta": {
      "property1": null,
      "property2": null
    },
    "totalCostUsd": 0,
    "routingAffinity": {
      "sourceAgentId": "string",
      "role": "string",
      "harnessProvider": "claude",
      "capabilities": []
    }
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/tasks/{id}/context

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Query Parameters

limit?integer
Default100
Range1 <= value <= 500

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/tasks/string/context"
{
  "snapshots": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
      "agentId": "string",
      "sessionId": "string",
      "contextUsedTokens": 0,
      "contextTotalTokens": 0,
      "contextPercent": 100,
      "eventType": "progress",
      "compactTrigger": "auto",
      "preCompactTokens": 0,
      "cumulativeInputTokens": 0,
      "cumulativeOutputTokens": 0,
      "contextFormula": "input-cache-output",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "summary": {
    "compactionCount": 0,
    "peakContextPercent": 100,
    "peakContextTokens": 0,
    "contextWindowSize": 0,
    "snapshotCount": 0
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/tasks/{id}/context

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/tasks/string/context" \  -H "Content-Type: application/json" \  -d '{    "eventType": "progress",    "sessionId": "string"  }'
{
  "ok": true,
  "snapshotId": "09520abc-01e6-4da1-8fa5-f10e3883c861"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/tasks/{id}/finish

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/tasks/string/finish" \  -H "Content-Type: application/json" \  -d '{    "status": "completed"  }'
{
  "success": true,
  "alreadyFinished": true,
  "task": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "key": "string",
    "agentId": "string",
    "creatorAgentId": "string",
    "task": "string",
    "title": "string",
    "status": "backlog",
    "source": "mcp",
    "taskType": "string",
    "tags": [],
    "priority": 50,
    "dependsOn": [],
    "offeredTo": "string",
    "offeredAt": "2019-08-24T14:15:22Z",
    "acceptedAt": "2019-08-24T14:15:22Z",
    "rejectionReason": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "lastUpdatedAt": "2019-08-24T14:15:22Z",
    "finishedAt": "2019-08-24T14:15:22Z",
    "notifiedAt": "2019-08-24T14:15:22Z",
    "failureReason": "string",
    "output": "string",
    "progress": "string",
    "slackChannelId": "string",
    "slackThreadTs": "string",
    "slackTriggerMessageTs": "string",
    "slackUserId": "string",
    "slackReplySent": false,
    "slackProgressMessageTs": "string",
    "slackTreeRootMessageTs": "string",
    "vcsProvider": "github",
    "vcsRepo": "string",
    "vcsEventType": "string",
    "vcsNumber": 0,
    "vcsCommentId": 0,
    "vcsAuthor": "string",
    "vcsUrl": "string",
    "vcsInstallationId": 0,
    "vcsNodeId": "string",
    "agentmailInboxId": "string",
    "agentmailMessageId": "string",
    "agentmailThreadId": "string",
    "mentionMessageId": "string",
    "mentionChannelId": "string",
    "dir": "string",
    "parentTaskId": "string",
    "claudeSessionId": "string",
    "model": "string",
    "modelTier": "smol",
    "effort": "off",
    "scheduleId": "string",
    "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
    "workflowRunStepId": "87990b6e-ec5d-4b37-8b4e-9ef25c331b99",
    "contextKey": "string",
    "outputSchema": {
      "property1": null,
      "property2": null
    },
    "followUpConfig": {
      "disabled": true,
      "onCompleted": "string",
      "onFailed": "string"
    },
    "wasPaused": false,
    "compactionCount": 0,
    "peakContextPercent": 100,
    "peakContextTokens": 0,
    "contextWindowSize": 0,
    "credentialKeySuffix": "string",
    "credentialKeyType": "string",
    "requestedByUserId": "string",
    "swarmVersion": "string",
    "provider": "claude",
    "providerMeta": {
      "property1": null,
      "property2": null
    },
    "harnessVariant": "string",
    "harnessVariantMeta": {
      "property1": null,
      "property2": null
    },
    "totalCostUsd": 0,
    "routingAffinity": {
      "sourceAgentId": "string",
      "role": "string",
      "harnessProvider": "claude",
      "capabilities": []
    }
  },
  "message": "string",
  "wasNoOp": true,
  "wasForcedOverwrite": true
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "success": false,
  "message": "string",
  "task": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "key": "string",
    "agentId": "string",
    "creatorAgentId": "string",
    "task": "string",
    "title": "string",
    "status": "backlog",
    "source": "mcp",
    "taskType": "string",
    "tags": [],
    "priority": 50,
    "dependsOn": [],
    "offeredTo": "string",
    "offeredAt": "2019-08-24T14:15:22Z",
    "acceptedAt": "2019-08-24T14:15:22Z",
    "rejectionReason": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "lastUpdatedAt": "2019-08-24T14:15:22Z",
    "finishedAt": "2019-08-24T14:15:22Z",
    "notifiedAt": "2019-08-24T14:15:22Z",
    "failureReason": "string",
    "output": "string",
    "progress": "string",
    "slackChannelId": "string",
    "slackThreadTs": "string",
    "slackTriggerMessageTs": "string",
    "slackUserId": "string",
    "slackReplySent": false,
    "slackProgressMessageTs": "string",
    "slackTreeRootMessageTs": "string",
    "vcsProvider": "github",
    "vcsRepo": "string",
    "vcsEventType": "string",
    "vcsNumber": 0,
    "vcsCommentId": 0,
    "vcsAuthor": "string",
    "vcsUrl": "string",
    "vcsInstallationId": 0,
    "vcsNodeId": "string",
    "agentmailInboxId": "string",
    "agentmailMessageId": "string",
    "agentmailThreadId": "string",
    "mentionMessageId": "string",
    "mentionChannelId": "string",
    "dir": "string",
    "parentTaskId": "string",
    "claudeSessionId": "string",
    "model": "string",
    "modelTier": "smol",
    "effort": "off",
    "scheduleId": "string",
    "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
    "workflowRunStepId": "87990b6e-ec5d-4b37-8b4e-9ef25c331b99",
    "contextKey": "string",
    "outputSchema": {
      "property1": null,
      "property2": null
    },
    "followUpConfig": {
      "disabled": true,
      "onCompleted": "string",
      "onFailed": "string"
    },
    "wasPaused": false,
    "compactionCount": 0,
    "peakContextPercent": 100,
    "peakContextTokens": 0,
    "contextWindowSize": 0,
    "credentialKeySuffix": "string",
    "credentialKeyType": "string",
    "requestedByUserId": "string",
    "swarmVersion": "string",
    "provider": "claude",
    "providerMeta": {
      "property1": null,
      "property2": null
    },
    "harnessVariant": "string",
    "harnessVariantMeta": {
      "property1": null,
      "property2": null
    },
    "totalCostUsd": 0,
    "routingAffinity": {
      "sourceAgentId": "string",
      "role": "string",
      "harnessProvider": "claude",
      "capabilities": []
    }
  },
  "alreadyFinished": true,
  "error": "string"
}
POST
/api/tasks/{id}/pause

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/tasks/string/pause"
{
  "success": true,
  "task": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "key": "string",
    "agentId": "string",
    "creatorAgentId": "string",
    "task": "string",
    "title": "string",
    "status": "backlog",
    "source": "mcp",
    "taskType": "string",
    "tags": [],
    "priority": 50,
    "dependsOn": [],
    "offeredTo": "string",
    "offeredAt": "2019-08-24T14:15:22Z",
    "acceptedAt": "2019-08-24T14:15:22Z",
    "rejectionReason": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "lastUpdatedAt": "2019-08-24T14:15:22Z",
    "finishedAt": "2019-08-24T14:15:22Z",
    "notifiedAt": "2019-08-24T14:15:22Z",
    "failureReason": "string",
    "output": "string",
    "progress": "string",
    "slackChannelId": "string",
    "slackThreadTs": "string",
    "slackTriggerMessageTs": "string",
    "slackUserId": "string",
    "slackReplySent": false,
    "slackProgressMessageTs": "string",
    "slackTreeRootMessageTs": "string",
    "vcsProvider": "github",
    "vcsRepo": "string",
    "vcsEventType": "string",
    "vcsNumber": 0,
    "vcsCommentId": 0,
    "vcsAuthor": "string",
    "vcsUrl": "string",
    "vcsInstallationId": 0,
    "vcsNodeId": "string",
    "agentmailInboxId": "string",
    "agentmailMessageId": "string",
    "agentmailThreadId": "string",
    "mentionMessageId": "string",
    "mentionChannelId": "string",
    "dir": "string",
    "parentTaskId": "string",
    "claudeSessionId": "string",
    "model": "string",
    "modelTier": "smol",
    "effort": "off",
    "scheduleId": "string",
    "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
    "workflowRunStepId": "87990b6e-ec5d-4b37-8b4e-9ef25c331b99",
    "contextKey": "string",
    "outputSchema": {
      "property1": null,
      "property2": null
    },
    "followUpConfig": {
      "disabled": true,
      "onCompleted": "string",
      "onFailed": "string"
    },
    "wasPaused": false,
    "compactionCount": 0,
    "peakContextPercent": 100,
    "peakContextTokens": 0,
    "contextWindowSize": 0,
    "credentialKeySuffix": "string",
    "credentialKeyType": "string",
    "requestedByUserId": "string",
    "swarmVersion": "string",
    "provider": "claude",
    "providerMeta": {
      "property1": null,
      "property2": null
    },
    "harnessVariant": "string",
    "harnessVariantMeta": {
      "property1": null,
      "property2": null
    },
    "totalCostUsd": 0,
    "routingAffinity": {
      "sourceAgentId": "string",
      "role": "string",
      "harnessProvider": "claude",
      "capabilities": []
    }
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/tasks/{id}/progress

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "http://localhost:3013/api/tasks/string/progress" \  -H "Content-Type: application/json" \  -d '{    "progress": "string"  }'
{
  "success": true
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/tasks/{id}/resume

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/tasks/string/resume"
{
  "success": true,
  "task": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "key": "string",
    "agentId": "string",
    "creatorAgentId": "string",
    "task": "string",
    "title": "string",
    "status": "backlog",
    "source": "mcp",
    "taskType": "string",
    "tags": [],
    "priority": 50,
    "dependsOn": [],
    "offeredTo": "string",
    "offeredAt": "2019-08-24T14:15:22Z",
    "acceptedAt": "2019-08-24T14:15:22Z",
    "rejectionReason": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "lastUpdatedAt": "2019-08-24T14:15:22Z",
    "finishedAt": "2019-08-24T14:15:22Z",
    "notifiedAt": "2019-08-24T14:15:22Z",
    "failureReason": "string",
    "output": "string",
    "progress": "string",
    "slackChannelId": "string",
    "slackThreadTs": "string",
    "slackTriggerMessageTs": "string",
    "slackUserId": "string",
    "slackReplySent": false,
    "slackProgressMessageTs": "string",
    "slackTreeRootMessageTs": "string",
    "vcsProvider": "github",
    "vcsRepo": "string",
    "vcsEventType": "string",
    "vcsNumber": 0,
    "vcsCommentId": 0,
    "vcsAuthor": "string",
    "vcsUrl": "string",
    "vcsInstallationId": 0,
    "vcsNodeId": "string",
    "agentmailInboxId": "string",
    "agentmailMessageId": "string",
    "agentmailThreadId": "string",
    "mentionMessageId": "string",
    "mentionChannelId": "string",
    "dir": "string",
    "parentTaskId": "string",
    "claudeSessionId": "string",
    "model": "string",
    "modelTier": "smol",
    "effort": "off",
    "scheduleId": "string",
    "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
    "workflowRunStepId": "87990b6e-ec5d-4b37-8b4e-9ef25c331b99",
    "contextKey": "string",
    "outputSchema": {
      "property1": null,
      "property2": null
    },
    "followUpConfig": {
      "disabled": true,
      "onCompleted": "string",
      "onFailed": "string"
    },
    "wasPaused": false,
    "compactionCount": 0,
    "peakContextPercent": 100,
    "peakContextTokens": 0,
    "contextWindowSize": 0,
    "credentialKeySuffix": "string",
    "credentialKeyType": "string",
    "requestedByUserId": "string",
    "swarmVersion": "string",
    "provider": "claude",
    "providerMeta": {
      "property1": null,
      "property2": null
    },
    "harnessVariant": "string",
    "harnessVariantMeta": {
      "property1": null,
      "property2": null
    },
    "totalCostUsd": 0,
    "routingAffinity": {
      "sourceAgentId": "string",
      "role": "string",
      "harnessProvider": "claude",
      "capabilities": []
    }
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
PUT
/api/tasks/{id}/session

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "http://localhost:3013/api/tasks/string/session" \  -H "Content-Type: application/json" \  -d '{    "claudeSessionId": "string",    "provider": "devin",    "providerMeta": {      "sessionUrl": "string"    }  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "key": "string",
  "agentId": "string",
  "creatorAgentId": "string",
  "task": "string",
  "title": "string",
  "status": "backlog",
  "source": "mcp",
  "taskType": "string",
  "tags": [],
  "priority": 50,
  "dependsOn": [],
  "offeredTo": "string",
  "offeredAt": "2019-08-24T14:15:22Z",
  "acceptedAt": "2019-08-24T14:15:22Z",
  "rejectionReason": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastUpdatedAt": "2019-08-24T14:15:22Z",
  "finishedAt": "2019-08-24T14:15:22Z",
  "notifiedAt": "2019-08-24T14:15:22Z",
  "failureReason": "string",
  "output": "string",
  "progress": "string",
  "slackChannelId": "string",
  "slackThreadTs": "string",
  "slackTriggerMessageTs": "string",
  "slackUserId": "string",
  "slackReplySent": false,
  "slackProgressMessageTs": "string",
  "slackTreeRootMessageTs": "string",
  "vcsProvider": "github",
  "vcsRepo": "string",
  "vcsEventType": "string",
  "vcsNumber": 0,
  "vcsCommentId": 0,
  "vcsAuthor": "string",
  "vcsUrl": "string",
  "vcsInstallationId": 0,
  "vcsNodeId": "string",
  "agentmailInboxId": "string",
  "agentmailMessageId": "string",
  "agentmailThreadId": "string",
  "mentionMessageId": "string",
  "mentionChannelId": "string",
  "dir": "string",
  "parentTaskId": "string",
  "claudeSessionId": "string",
  "model": "string",
  "modelTier": "smol",
  "effort": "off",
  "scheduleId": "string",
  "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
  "workflowRunStepId": "87990b6e-ec5d-4b37-8b4e-9ef25c331b99",
  "contextKey": "string",
  "outputSchema": {
    "property1": null,
    "property2": null
  },
  "followUpConfig": {
    "disabled": true,
    "onCompleted": "string",
    "onFailed": "string"
  },
  "wasPaused": false,
  "compactionCount": 0,
  "peakContextPercent": 100,
  "peakContextTokens": 0,
  "contextWindowSize": 0,
  "credentialKeySuffix": "string",
  "credentialKeyType": "string",
  "requestedByUserId": "string",
  "swarmVersion": "string",
  "provider": "claude",
  "providerMeta": {
    "property1": null,
    "property2": null
  },
  "harnessVariant": "string",
  "harnessVariantMeta": {
    "property1": null,
    "property2": null
  },
  "totalCostUsd": 0,
  "routingAffinity": {
    "sourceAgentId": "string",
    "role": "string",
    "harnessProvider": "claude",
    "capabilities": []
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/tasks/{id}/steer

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/tasks/string/steer" \  -H "Content-Type: application/json" \  -d '{    "message": "string"  }'
{
  "outcome": "steered",
  "steeringMessageId": "099d6cee-5ee4-4398-bb77-b2066e45efe3",
  "promotedTaskId": "eccfaabc-92d6-4fa5-818c-c7d655a8e358",
  "effectiveMode": "steer",
  "degradedFrom": "steer"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/tasks/{id}/steering-messages

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/tasks/string/steering-messages"
{
  "messages": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
      "body": "string",
      "mode": "steer",
      "status": "pending",
      "deliveredMode": "steer",
      "source": "ui",
      "createdByKind": "user",
      "createdByUserId": "string",
      "createdByAgentId": "string",
      "promotedTaskId": "eccfaabc-92d6-4fa5-818c-c7d655a8e358",
      "createdAt": "2019-08-24T14:15:22Z",
      "deliveredAt": "2019-08-24T14:15:22Z",
      "handledAt": "2019-08-24T14:15:22Z",
      "handledNote": "string"
    }
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/tasks/{id}/supersede

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/tasks/string/supersede" \  -H "Content-Type: application/json" \  -d '{    "reason": "graceful_shutdown"  }'
{
  "success": true,
  "kind": "alreadyFinished",
  "task": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "key": "string",
    "agentId": "string",
    "creatorAgentId": "string",
    "task": "string",
    "title": "string",
    "status": "backlog",
    "source": "mcp",
    "taskType": "string",
    "tags": [],
    "priority": 50,
    "dependsOn": [],
    "offeredTo": "string",
    "offeredAt": "2019-08-24T14:15:22Z",
    "acceptedAt": "2019-08-24T14:15:22Z",
    "rejectionReason": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "lastUpdatedAt": "2019-08-24T14:15:22Z",
    "finishedAt": "2019-08-24T14:15:22Z",
    "notifiedAt": "2019-08-24T14:15:22Z",
    "failureReason": "string",
    "output": "string",
    "progress": "string",
    "slackChannelId": "string",
    "slackThreadTs": "string",
    "slackTriggerMessageTs": "string",
    "slackUserId": "string",
    "slackReplySent": false,
    "slackProgressMessageTs": "string",
    "slackTreeRootMessageTs": "string",
    "vcsProvider": "github",
    "vcsRepo": "string",
    "vcsEventType": "string",
    "vcsNumber": 0,
    "vcsCommentId": 0,
    "vcsAuthor": "string",
    "vcsUrl": "string",
    "vcsInstallationId": 0,
    "vcsNodeId": "string",
    "agentmailInboxId": "string",
    "agentmailMessageId": "string",
    "agentmailThreadId": "string",
    "mentionMessageId": "string",
    "mentionChannelId": "string",
    "dir": "string",
    "parentTaskId": "string",
    "claudeSessionId": "string",
    "model": "string",
    "modelTier": "smol",
    "effort": "off",
    "scheduleId": "string",
    "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
    "workflowRunStepId": "87990b6e-ec5d-4b37-8b4e-9ef25c331b99",
    "contextKey": "string",
    "outputSchema": {
      "property1": null,
      "property2": null
    },
    "followUpConfig": {
      "disabled": true,
      "onCompleted": "string",
      "onFailed": "string"
    },
    "wasPaused": false,
    "compactionCount": 0,
    "peakContextPercent": 100,
    "peakContextTokens": 0,
    "contextWindowSize": 0,
    "credentialKeySuffix": "string",
    "credentialKeyType": "string",
    "requestedByUserId": "string",
    "swarmVersion": "string",
    "provider": "claude",
    "providerMeta": {
      "property1": null,
      "property2": null
    },
    "harnessVariant": "string",
    "harnessVariantMeta": {
      "property1": null,
      "property2": null
    },
    "totalCostUsd": 0,
    "routingAffinity": {
      "sourceAgentId": "string",
      "role": "string",
      "harnessProvider": "claude",
      "capabilities": []
    }
  },
  "resumeTaskId": "string",
  "resumeTaskStatus": "backlog"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
PATCH
/api/tasks/{id}/title

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PATCH "http://localhost:3013/api/tasks/string/title" \  -H "Content-Type: application/json" \  -d '{    "title": "string"  }'
{
  "task": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "key": "string",
    "agentId": "string",
    "creatorAgentId": "string",
    "task": "string",
    "title": "string",
    "status": "backlog",
    "source": "mcp",
    "taskType": "string",
    "tags": [],
    "priority": 50,
    "dependsOn": [],
    "offeredTo": "string",
    "offeredAt": "2019-08-24T14:15:22Z",
    "acceptedAt": "2019-08-24T14:15:22Z",
    "rejectionReason": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "lastUpdatedAt": "2019-08-24T14:15:22Z",
    "finishedAt": "2019-08-24T14:15:22Z",
    "notifiedAt": "2019-08-24T14:15:22Z",
    "failureReason": "string",
    "output": "string",
    "progress": "string",
    "slackChannelId": "string",
    "slackThreadTs": "string",
    "slackTriggerMessageTs": "string",
    "slackUserId": "string",
    "slackReplySent": false,
    "slackProgressMessageTs": "string",
    "slackTreeRootMessageTs": "string",
    "vcsProvider": "github",
    "vcsRepo": "string",
    "vcsEventType": "string",
    "vcsNumber": 0,
    "vcsCommentId": 0,
    "vcsAuthor": "string",
    "vcsUrl": "string",
    "vcsInstallationId": 0,
    "vcsNodeId": "string",
    "agentmailInboxId": "string",
    "agentmailMessageId": "string",
    "agentmailThreadId": "string",
    "mentionMessageId": "string",
    "mentionChannelId": "string",
    "dir": "string",
    "parentTaskId": "string",
    "claudeSessionId": "string",
    "model": "string",
    "modelTier": "smol",
    "effort": "off",
    "scheduleId": "string",
    "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
    "workflowRunStepId": "87990b6e-ec5d-4b37-8b4e-9ef25c331b99",
    "contextKey": "string",
    "outputSchema": {
      "property1": null,
      "property2": null
    },
    "followUpConfig": {
      "disabled": true,
      "onCompleted": "string",
      "onFailed": "string"
    },
    "wasPaused": false,
    "compactionCount": 0,
    "peakContextPercent": 100,
    "peakContextTokens": 0,
    "contextWindowSize": 0,
    "credentialKeySuffix": "string",
    "credentialKeyType": "string",
    "requestedByUserId": "string",
    "swarmVersion": "string",
    "provider": "claude",
    "providerMeta": {
      "property1": null,
      "property2": null
    },
    "harnessVariant": "string",
    "harnessVariantMeta": {
      "property1": null,
      "property2": null
    },
    "totalCostUsd": 0,
    "routingAffinity": {
      "sourceAgentId": "string",
      "role": "string",
      "harnessProvider": "claude",
      "capabilities": []
    }
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
PATCH
/api/tasks/{id}/vcs

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PATCH "http://localhost:3013/api/tasks/string/vcs" \  -H "Content-Type: application/json" \  -d '{    "vcsProvider": "github",    "vcsRepo": "string",    "vcsNumber": 0,    "vcsUrl": "http://example.com"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "key": "string",
  "agentId": "string",
  "creatorAgentId": "string",
  "task": "string",
  "title": "string",
  "status": "backlog",
  "source": "mcp",
  "taskType": "string",
  "tags": [],
  "priority": 50,
  "dependsOn": [],
  "offeredTo": "string",
  "offeredAt": "2019-08-24T14:15:22Z",
  "acceptedAt": "2019-08-24T14:15:22Z",
  "rejectionReason": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastUpdatedAt": "2019-08-24T14:15:22Z",
  "finishedAt": "2019-08-24T14:15:22Z",
  "notifiedAt": "2019-08-24T14:15:22Z",
  "failureReason": "string",
  "output": "string",
  "progress": "string",
  "slackChannelId": "string",
  "slackThreadTs": "string",
  "slackTriggerMessageTs": "string",
  "slackUserId": "string",
  "slackReplySent": false,
  "slackProgressMessageTs": "string",
  "slackTreeRootMessageTs": "string",
  "vcsProvider": "github",
  "vcsRepo": "string",
  "vcsEventType": "string",
  "vcsNumber": 0,
  "vcsCommentId": 0,
  "vcsAuthor": "string",
  "vcsUrl": "string",
  "vcsInstallationId": 0,
  "vcsNodeId": "string",
  "agentmailInboxId": "string",
  "agentmailMessageId": "string",
  "agentmailThreadId": "string",
  "mentionMessageId": "string",
  "mentionChannelId": "string",
  "dir": "string",
  "parentTaskId": "string",
  "claudeSessionId": "string",
  "model": "string",
  "modelTier": "smol",
  "effort": "off",
  "scheduleId": "string",
  "workflowRunId": "5ca99e95-15bc-4b23-a2d2-f5f4060373ab",
  "workflowRunStepId": "87990b6e-ec5d-4b37-8b4e-9ef25c331b99",
  "contextKey": "string",
  "outputSchema": {
    "property1": null,
    "property2": null
  },
  "followUpConfig": {
    "disabled": true,
    "onCompleted": "string",
    "onFailed": "string"
  },
  "wasPaused": false,
  "compactionCount": 0,
  "peakContextPercent": 100,
  "peakContextTokens": 0,
  "contextWindowSize": 0,
  "credentialKeySuffix": "string",
  "credentialKeyType": "string",
  "requestedByUserId": "string",
  "swarmVersion": "string",
  "provider": "claude",
  "providerMeta": {
    "property1": null,
    "property2": null
  },
  "harnessVariant": "string",
  "harnessVariantMeta": {
    "property1": null,
    "property2": null
  },
  "totalCostUsd": 0,
  "routingAffinity": {
    "sourceAgentId": "string",
    "role": "string",
    "harnessProvider": "claude",
    "capabilities": []
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}

Task Templates

List reusable task templates — pre-defined task definitions agents pick up to start common swarm workflows

Trackers

Integrate with Linear and Jira ticket trackers — sync issues to swarm tasks bidirectionally