Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Account

List an AI plan's models

The models teammates can run on with this plan, and the efforts each takes, for PATCH /agents/{handle} and PATCH /ai-plans/{plan} (model, effort). A ChatGPT plan offers what its signed-in account may use, read on the workspace's computer (empty until the plan has run there once). A Claude plan offers Claude's current models. A plan with an API key offers the chat models that its provider lists for the key, read on the workspace's computer. Grok and Copilot offer none: they run on the default model of their CLI. efforts are the efforts that the plan's default model takes.

get/api/v1/ai-plans/{plan}/models

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.

Other ways to call it

CLItroopy ai models
MCP tooltroopy_list_ai_models
Rate limit30 calls in 60 seconds, for each key

Path parameters

plan*string

An AI plan's id, from GET /ai-plans

Response

200 · application/json
data*object
3 properties
plan*string

An AI plan's id, from GET /ai-plans

models*array<object>
4 properties
id*string
name*string
description*string | null
efforts*array<enum<string>>

The efforts it takes

lowmediumhighxhighmax

efforts*array<enum<string>>

The efforts the plan's default model takes

lowmediumhighxhighmax

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
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.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
429 rate_limitedWait the number of seconds in Retry-After, then retry.