Skip to content

by Startups.Studio

Core grammar Action Task

Task.claim

POST /{namespace}/tasks/{task}/claim

Claim takes an offered Task from a shared queue or a handoff and makes the calling Worker its assignee.

Noun: Task
Mode: do
Event: Task.claimed

You, to your agent

Claim the latest task.

curl -X POST https://api.sb/ledgerlark.com/tasks/task_1/claim \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const task = await $.Task.claim({ task: 'task_1' })

npx startup-builder do Task.claim --json '{"task":"task_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Task.claim({ task: 'task_1' })"
  }
}

Inputs

Input	Type	Required	Description
`task`	Task	required	The offered Task.

Outputs

Output	Type	Required	Description
`task`	Task	required	The Task, assigned to the caller.

Effects

Emits Task.claimed.
Performed by the Supply Manager.
Removes the Task from every other Worker’s queue.
Releases the claim if the Task sits untouched past its claim window.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Task.claim

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Task.assign

Previous Page

Task.complete

Next Page