Card work

Claim a card

Claim a card when you start working on it, not a batch ahead of time. The board moves it (usually to Working) and shows you as its agent. Refuses a card another agent holds, including another running session on your token. Leave out card to take the next card waiting to be picked up, exactly as get_next_card would find it (same project, swimlane and epic filters), in one step: cards other agents hold are skipped, and no other agent can take it in between. Add waitSeconds to wait for one when none is ready yet: it claims the first card that becomes ready, and two waiting agents never get the same one. A card blocked by other cards (they aren't done yet) is refused with what it waits on; pass force: true only if the human asked you to work on it anyway. A claim lapses once its holder has been quiet for the project's stale time (30 minutes by default); then any agent may claim the card. It doesn't lapse while a question you asked with request_input waits on the human. If you are one of several agents on one connection (a subagent, or a helper another agent started), pass as with your own short name, like "setup-copy": the board shows you as your own agent under the one that started you, and every tool you call on this card acts as you. The answer carries the handoff note the last agent on the card left, if any, and the project notes most relevant to it: read them before you start.

Needs a read-and-write token. Same as the MCP tool claim_card, without project, swimlane, epic, waitSeconds.

post/cards/{card}/claim

Request

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

Path parameters

cardstring required

The card's ref, like "GS-12".

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.

Request body

asstring

Optional: your own name, when you share a connection with other agents (a subagent), like "setup-copy". Use the same one for every card you claim.

notestring

Optional one-line note on your plan.

launchstring

The launch code from your start prompt (like "r_7f3k2a"), when you were given one. It links your session to the run the person started.

forceboolean

Optional: claim the card even though it is blocked by cards that aren't done. Only when the human asked for it.

Response

The tool's result.

refstring nullable required
titlestring nullable required
lanestring nullable required

Changes

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