Every sample on every page follows this. Change it any time.

Get a test key
BashBrainTeammatesPricingDevelopersGet a test key

Work

The work Bash does on its computer: list it, read it, stop it or delete it.

Send Authorization: Bearer vk_test_... on every call. Every route of Work.

POST/v1/tasks/{task_id}/stopStop this piece of work only.

Your API key, scope runtime or all. On the card: ask. Over HTTP it is made from the contract: fill in each {…} and every value.

Request2 fields

Path

task_idstringrequiredThe piece of work's id (task_...).
Type
string

Headers

Idempotency-KeystringSend the same key to retry this call safely for 24 hours.
Type
string
Answers 2003 fields
taskobjectThe task, after the stop.
idstringThe task: one piece of work Bash started (task_...).
Example
task_91d
object"task"Always task.
Type
"task"
user_idstring | nullYour id for its user; null on your company's own Bash.
Type
string | null
conversation_idstring | nullThe conversation that started it (conv_...); null when none did.
Type
string | null
deployment_idstring | nullThe deployment it runs on (dep_...); null when none.
Type
string | null
deployment_versioninteger | nullThe version of that deployment it runs on; null when none.
Type
integer | null
status"queued" | "working" | "waiting" | "done" | "failed"queued: not started yet. working: running on the user's computer. waiting: it waits on an approval or a question. done or failed: it has ended.
Type
"queued" | "working" | "waiting" | "done" | "failed"
titlestring | nullWhat the work is, in a few words; null until Bash names it.
Type
string | null
progressobject[]Its plan, as its latest to-do list; empty when it has none.
contentstringOne step of its plan.
Type
string
statusstringWhere that step is: pending, in_progress or completed.
Type
string
resultobjectWhat the work came to.
textstring | nullThe work's answer: its final reply. Read one task for all of it; a list cuts it to 280 characters, as does a task that ended before its answer was recorded. Null until it has any, or when the work ended with no final reply.
Type
string | null
dataany | nullData it returned for an output_schema; null when it returned none.
Type
any | null
outcomeobject | nullWhether it met the success criteria of its message; null when there were none.
metbooleanWhether it met the success criteria.
Type
boolean
reasonstringWhy, in a sentence.
Type
string
cost_usdnumberWhat it has cost so far, in billed US dollars; the last charges can land a few seconds after it ends.
Example
0.0412
cost_breakdownobjectThe same cost, by kind of spend.
orchestratornumberBash's own replies in the conversation, in billed US dollars; 0 on a piece of work.
Type
number
intelligencenumberThe thinking Bash did while it worked, in billed US dollars.
Type
number
toolsnumberThe tools and apps Bash used, in billed US dollars.
Type
number
computenumberTime on Bash's computer, in billed US dollars.
Type
number
backgroundnumberWork Bash did in the background, such as remembering and tidying, in billed US dollars.
Type
number
voicenumberVoice call time, in billed US dollars.
Type
number
created_atstringWhen it started, as an ISO 8601 time.
Type
string
updated_atstringWhen it last changed, as an ISO 8601 time.
Type
string
deliveredbooleanWhether the stop surely reached the work.
Type
boolean
reason"local_relay_down" | "nothing_to_kill" | "kill_not_permitted" | "not_running" | nullWhy the stop did not land; null when it did. not_running: it was at rest, so nothing was sent. nothing_to_kill: nothing was running. local_relay_down: it runs on the user's own computer, which cannot be reached. kill_not_permitted: it could not be reached, so it may still be running.
Type
"local_relay_down" | "nothing_to_kill" | "kill_not_permitted" | "not_running" | null
HTTP

No sample in your language for this route, so here it is over HTTP.

curl -X POST "$VESTRA_BASE_URL/v1/tasks/{task_id}/stop" \  -H "Authorization: Bearer $VESTRA_API_KEY"