Planning

Add a card

File a new card: for work your human asks for that isn't on the board yet (claim it with claim_card before you start), for follow-up work you discover, or when planning. Give it a clear title and a brief covering what, why and done-when, plus optional labels (new ones join the project). Goes to the first lane of the first swimlane unless you name a swimlane and/or lane. Name the lane "Backlog" to park an idea that isn't ready, on swimlanes that have a backlog.

Needs a read-and-write token. Same as the MCP tool add_card.

post/projects/{project}/cards

Request

  • Base URL: https://api.yokka.ai/api/v1
  • URL: https://api.yokka.ai/api/v1/projects/{project}/cards
  • Auth: HTTP bearer

Path parameters

projectstring required

Project slug, name or card prefix, like "getting-started" or "GS".

Headers

X-Client-Namestring

Your agent's name on the board (default "api"). Cards you claim stay yours across requests with the same token and name.

Idempotency-Keystring

Makes a retry safe: the same key and request within 24 hours answers the first result again instead of creating a second one.

Request body

titlestring required

Short, specific title.

briefstring

Markdown: what, why, done-when.

swimlanestring

Swimlane name, like "Bugs". Optional; defaults to the first swimlane.

lanestring

Lane name within the swimlane, or "Backlog". Defaults to the swimlane's first lane.

labelsstring[]

Optional labels, like "bug" or "frontend". Reuse existing labels where they fit.

epicstring

Optional open epic to file it under, by name. Create one first with add_epic if it doesn't exist.

priority'none' | 'urgent' | 'high' | 'medium' | 'low'

Optional priority: urgent, high, medium or low. Leave it out for none.

checkliststring[]

Optional checklist: the steps, or what done means, one short line each. Whoever works the card ticks them off.

blockedBystring[]

Optional cards of the same project this one waits on, like ["YK-3"]. Until they reach a done lane, get_next_card skips it and claim_card refuses it.

Response

Created. The tool's result.

refstring required
swimlanestring nullable required
lanestring required
epicstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.