agent-swarm.devagent-swarm.dev

Checklist

Checklist API endpoints

GET/api/checklist

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Response Body

application/json

curl -X GET "http://localhost:3013/api/checklist"
{
  "items": [
    {
      "id": "string",
      "scope": "swarm",
      "userId": "string",
      "kind": "channel",
      "label": "string",
      "href": "string",
      "meta": {
        "property1": null,
        "property2": null
      },
      "sortOrder": 0,
      "status": "open",
      "statusChangedAt": "string",
      "statusChangedBy": "string",
      "statusChangedByName": "string",
      "statusReason": "string",
      "nudgedAt": "string",
      "nudgedTaskId": "string",
      "signal": true,
      "done": true,
      "editable": true,
      "createdAt": "string",
      "lastUpdatedAt": "string"
    }
  ],
  "canEditSwarm": true
}
POST/api/checklist/items

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

application/json

application/json

curl -X POST "http://localhost:3013/api/checklist/items" \  -H "Content-Type: application/json" \  -d '{    "kind": "channel",    "label": "string",    "scope": "swarm"  }'
{
  "item": {
    "id": "string",
    "scope": "swarm",
    "userId": "string",
    "kind": "channel",
    "label": "string",
    "href": "string",
    "meta": {
      "property1": null,
      "property2": null
    },
    "sortOrder": 0,
    "status": "open",
    "statusChangedAt": "string",
    "statusChangedBy": "string",
    "statusChangedByName": "string",
    "statusReason": "string",
    "nudgedAt": "string",
    "nudgedTaskId": "string",
    "signal": true,
    "done": true,
    "editable": true,
    "createdAt": "string",
    "lastUpdatedAt": "string"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
PATCH/api/checklist/items/{id}

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 PATCH "http://localhost:3013/api/checklist/items/string" \  -H "Content-Type: application/json" \  -d '{    "action": "remove"  }'
{
  "item": {
    "id": "string",
    "scope": "swarm",
    "userId": "string",
    "kind": "channel",
    "label": "string",
    "href": "string",
    "meta": {
      "property1": null,
      "property2": null
    },
    "sortOrder": 0,
    "status": "open",
    "statusChangedAt": "string",
    "statusChangedBy": "string",
    "statusChangedByName": "string",
    "statusReason": "string",
    "nudgedAt": "string",
    "nudgedTaskId": "string",
    "signal": true,
    "done": true,
    "editable": true,
    "createdAt": "string",
    "lastUpdatedAt": "string"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}