List models
List models.
GET
/v1/agent/modelsRequest
| Method and path | GET/v1/agent/models |
|---|---|
| Base URL | https://api.boxline.dev |
| Authentication | Your API key in the x-api-key header (or Authorization: Bearer). The examples read it from BOXLINE_API_KEY. |
curl "https://api.boxline.dev/v1/agent/models" \ -H "x-api-key: $BOXLINE_API_KEY"import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLconst catalog = await bx.agent.models();console.log(catalog.default);for (const p of catalog.providers) console.log(p.id, p.available, p.models.map((m) => m.id));from boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLcatalog = bx.agent.models()print(catalog["default"])for p in catalog["providers"]: print(p["id"], p["available"], [m["id"] for m in p["models"]])Responses
200 OK
Providers and their models, and which are configured on this server.
Fields
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
default | object | – | – | |
default.provider | string | – | anthropic, openai, xai, google | Anthropic Claude, OpenAI, Grok (xAI), Google Gemini. Grok and Gemini have no computer use (mode computer is 400). |
default.model | string | – | – | |
providers | object[] | – | – | |
providers[].id | string | – | anthropic, openai, xai, google | Anthropic Claude, OpenAI, Grok (xAI), Google Gemini. Grok and Gemini have no computer use (mode computer is 400). |
providers[].name | string | – | – | |
providers[].available | boolean | – | – | A call could be made now for this project. |
providers[].keySource | string | null | – | project, platform | Whose key a call would use now (the project's effective choice); null when there is none. |
providers[].reason | string | null | – | – | |
providers[].models | object[] | – | – | |
providers[].models[].id | string | – | – | |
providers[].models[].name | string | – | – | |
providers[].models[].note | string | – | – | |
providers[].models[].pricePerMTok | object | – | – | |
providers[].models[].pricePerMTok.input | number | – | – | |
providers[].models[].pricePerMTok.output | number | – | – | |
providers[].models[].supportsEffort | boolean | – | – | |
providers[].models[].supportsComputerUse | boolean | – | – | Agent runs with mode "computer" work with this model. |
providers[].models[].computerTool | string | null | – | computer_toolset_20260801, computer, null | The provider's computer-use tool the model gets in mode "computer" (Claude's computer toolset, or OpenAI's GA computer tool). |
providers[].models[].default | boolean | – | – |
{ "default": { "provider": "anthropic", "model": "claude-sonnet-5-5" }, "providers": [ { "id": "anthropic", "name": "Work account", "available": false, "keySource": "project", "reason": "…", "models": [ { "id": "…", "name": "Work account", "note": "…", "pricePerMTok": {}, "supportsEffort": false, "supportsComputerUse": false, "computerTool": "computer_toolset_20260801", "default": false } ] } ]}Errors
Errors have a matching HTTP status and the same body. code is stable, so check it in your code; message is for people. See Errors and request ids.
| Status | Codes | When |
|---|---|---|
| 401 Unauthorized | unauthorized | Missing or invalid API key. |
{ "error": { "code": "not_found", "message": "session not found", "requestId": "req_4fJx0aQm2Lk9Pz7N" }}Learn more
These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.