API reference / Troop
Switch teammate tools on or off
Switches families or single tools on or off for the whole troop. A run leaves out the tools that are off. The families that the troop needs stay on. A family that switches as one takes its key in families, not one of its tools. Needs an owner or admin.
/api/v1/teammate-toolsOther ways to call it
troopy tools switchIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Body
application/jsonfamiliesarray<enum<string>>Families to switch, like web or stripe
browserbrainhelptasksskillsinboxbrain_editsemailhiringroutinescanvasesresearchbrandwebpicturesleadsand 13 more
At most 29 items
toolsarray<string>Single tools to switch, like search_web
At most 100 items
on*booleanResponse
200 · application/jsondata*object7 properties
days*integerThe days of use that each count covers
switchable*integerHow many tools can be switched off
on*integerHow many of those are on
teammates*array<object>The troop, the most use first
5 properties
handle*stringname*stringavatar*objectIts face: a bot-avatars body type, colour (#RRGGBB), face and shading, a robot head, or an object with two eyes
6 properties
shape*enum<string>cloverflowertrianglesquareblobghostcircledropstardroidmechalienhexagoncatcloudpilland 2 more
color*stringface*enum<string>eyesmouth
shadingenum<string>How its body is lit; fabric when unset
fabricplasticcrispsmoothflat
robotobjectA TV-headed robot (robot-heads) in place of the bot. shape, color, face and shading stay for the bot
5 properties
shape*enum<string>rectanglesquarecirclehexagon
shell*stringThe colour of its shell
trim*stringThe colour of its ears and of the collar of its antenna
screen*stringThe colour of the lights on its screen
antenna*booleanobjectobjectAn object with two eyes in place of the bot. shape, color, face and shading stay for the bot
2 properties
shape*enum<string>circlesquaretrianglepilldrophexagonpentagoncloudbeancloverflowersparkleburstapplechatbulband 13 more
color*stringThe colour of the object
paused*booleanuses*integerIts tool calls in the last days days
families*array<object>9 properties
key*enum<string>browserbrainhelptasksskillsinboxbrain_editsemailhiringroutinescanvasesresearchbrandwebpicturesleadsand 13 more
section*enum<string>alwaysbrainwebsalesnumbersengineeringcustom
name*stringabout*stringalways*booleanThe troop needs it to work, so it never switches off
whole*booleanIts tools switch on and off as one: send its key in families, not one of its tools
stops*string | nullWhat stops while it is off
needs*array<object>Apps its tools read from; it can't work until each is connected (POST /apps/{provider})
3 properties
id*enum<string>stripeposthoggithubnotionhunterlemonsqueezypolarpaddledodopaymentssearchconsolemetaadsgooglecalendargeminiopenaifalreplicate
name*stringconnected*booleantools*array<object>8 properties
id*stringThe tool's id, like search_web
label*stringabout*stringWhat it gives, in one line
on*booleanOff: no teammate uses it until an owner or admin switches it on
asks*booleanA teammate that holds it asks a person before it runs
holders*array<string>The handles of the teammates whose roles hold it
uses*integerIts calls in the last days days, by every teammate
usedBy*array<object>Its calls by teammate, the most first
2 properties
handle*stringuses*integertasks*array<object>The tasks with the most tool calls, the troop's and each teammate's own, the most first
4 properties
key*stringThe task's key, like VIR-12
title*stringuses*integerusedBy*array<object>Its calls by teammate, the most first
2 properties
handle*stringuses*integernoTask*objectThe tool calls of chats and answers with no task
2 properties
uses*integerusedBy*array<object>Its calls by teammate, the most first
2 properties
handle*stringuses*integer