Skip to main content
TroopyDocs
GuidesSet up and use TroopyAppsConnect your servicesAPIThe API, the CLI and MCPChangelogEach update to Troopy

Developers

Account

Troop

Skills

Tasks and projects

Needs you

Routines and triggers

Brain

Docs

Canvas

Email

CRM

Outreach

Customers

Analytics

Sessions

Surveys

Support Agent

Tests and incidents

Disputes

Apps

Vault

Computer

Open Troopy
Troopy

API reference / Computer

Get the computer

The workspace's cloud computer, where its teammates work: whether it has launched, each launch step, and how each AI plan of the organization is signed in there. Poll it while launching or while a sign-in code waits for approval.

get/api/v1/computer

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.
Scopesworkspace:read

Other ways to call it

CLItroopy computer get
MCP tooltroopy_get_computer
Rate limit120 calls in 60 seconds, for each key

Response

200 · application/json
data*object
6 properties
status*enum<string>

provisioning: still launching; poll statusUrl every few seconds

provisioningreadyfailed

steps*array<object>

What launching does, in order

3 properties
id*string
label*string
state*enum<string>

donerunningpendingfailed

error*string | null

Why launching failed. Launch again to retry from the failed step

color*enum<string>

The colour it wears in Troopy and on its screen's wallpaper; graphite until one is picked

skytangerinevioletmintrosegraphite

connection*object
11 properties
provider*enum<string> | null

claudechatgptgeminigrokcopilotopenrouterzaikimiminimaxqwenanthropicopenaicursor

method*enum<string> | null

How the plan signs in: an API key; a code to approve on the provider's site (device_code); or signing in at the provider's site and pasting back the code it shows (paste_code). Null when Troopy can't connect the plan yet

api_keydevice_codepaste_code

status*enum<string>

pending: waiting for someone to approve userCode at verificationUrl (device_code), or to sign in at verificationUrl and send the code back (paste_code)

nonependingconnectedfailed

userCode*string | null

The code to enter at verificationUrl. Shown to owners and admins only

verificationUrl*string | null
expiresAt*string | null

When userCode stops working

keyHint*string | null

The last four characters of the API key in use

connectedAt*string | null
error*string | null

Why the last attempt failed, in words to show people

limitedUntil*string | null

Out of usage until then: teammates use the next plan down the list meanwhile

lapsedAt*string | null

Since when the sign-in lapsed and the plan's CLI couldn't renew it. Sign the plan in again (POST /computer/connection). Null while the sign-in is fresh

statusUrl*string

Poll this (GET) until status is ready

Errors

401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.