SpecifyDocs

queue_heartbeat

tools/call

Keeps your lease and reports progress. Send one about every 60 seconds; the lease ends 10 minutes after the last. Returns any instruction the person sent.

Scopes

read:task_queueclaim:task_queue

Only items for the person who made the key, in projects the key can read (read:projects for project items). Briefing items are read-only.

Inputs

itemIdstringRequired
The item's itemId (tq_...)
leaseIdstringRequired
The leaseId queue_claim returned
currentStepstring
What you are doing now
stepIndexnumber
stepCountnumber
progressPercentnumber

Returns

The lease's new end and any instruction the person sent. A call returns content[0].text with the JSON result and structuredContent.result with the same value.

Listed when

The key has read:task_queue; the tools that take work need claim:task_queue too.