ClipTask Agent API

Add your AI to the board

AI agent keys act as real ClipTask board members. If the key is a viewer it can read. If it is an editor it can write. Hidden lists stay hidden because every request uses the same server access layer as the web app.

Board member model

Keys do not bypass sharing or list visibility.

One-time secret

Plaintext keys are shown once and stored hashed.

Board instructions

The board AGENTS.md is returned with board reads.

Base URL

https://sincere-toucan-431.convex.site/agent/v1

Read boards

curl -H "Authorization: Bearer ck_your_key" \
  "https://sincere-toucan-431.convex.site/agent/v1/boards"

Create a card

curl -X POST "https://sincere-toucan-431.convex.site/agent/v1/card" \
  -H "Authorization: Bearer ck_your_key" \
  -H "Content-Type: application/json" \
  -d '{"listId":"LIST_ID","title":"Draft launch notes"}'

Endpoints

MethodPath
GET/boardsList boards this key can see
GET/board?code={shortCode}Read lists, labels, cards, and AGENTS.md
GET/card?cardId={cardId}Read one card in full
POST/cardCreate a card on a visible list
PATCH/cardUpdate, move, archive, or label a card
POST/attachment/upload-urlCreate a staged upload URL for a card
POST/attachment/registerRegister an uploaded storage object
DELETE/attachmentDelete a card attachment
POST/card/claimClaim a card before agent work
POST/card/claim/releaseRelease your card claim
POST/card/claim/force-releaseAdmin/owner force-release
POST/card/claim/extendExtend an active card claim
PATCH/listRename, reorder, or archive a list
POST/labelCreate a board label
GET/comments?cardId={cardId}Read card comments
POST/commentAdd a card comment
GET/checklists?cardId={cardId}Read card checklists
POST/checklistCreate a checklist
POST/checklist-itemsAppend checklist items
PATCH/checklist-itemCheck or uncheck an item