Skip to content
OpenCode
Esc
navigateopen⌘Jpreview

List models

Retrieve available models ordered by release date.

GET/api/model
Query parameters
locationobject | any
Responses
200Success
locationLocation.Inforequired
Show properties
directorystringrequired
workspaceIDobject
Show properties
object
projectobjectrequired
Show properties
idstringrequired
directorystringrequired
dataModel.Info[]required
Show properties
Array of Model.Info
idstringrequired
modelIDstringrequired
providerIDstringrequired
familystring
namestringrequired
packagestring
settingsobject
headersobject
bodyobject
capabilitiesModel.Capabilitiesrequired
Show properties
toolsbooleanrequired
inputstring[]required
outputstring[]required
variantsModel.Variant[]required
Show properties
Array of Model.Variant
idstringrequired
settingsobject
headersobject
bodyobject
timeobjectrequired
Show properties
releasednumberrequired
costModel.Cost[]required
Show properties
Array of Model.Cost
tierobject
Show properties
typestringrequired
Allowed:context
sizeintegerrequired
inputMoney.USDPerMillionTokensrequired
outputMoney.USDPerMillionTokensrequired
cacheobjectrequired
Show properties
readMoney.USDPerMillionTokensrequired
writeMoney.USDPerMillionTokensrequired
statusstringrequired
Allowed:alphabetadeprecatedactive
enabledbooleanrequired
limitobjectrequired
Show properties
contextintegerrequired
inputinteger
outputintegerrequired
400InvalidRequestError
_tagstringrequired
Allowed:InvalidRequestError
messagestringrequired
kindstring | any
Show properties
Any of:
string
string
any
any
fieldstring | any
Show properties
Any of:
string
string
any
any
401UnauthorizedError
_tagstringrequired
Allowed:UnauthorizedError
messagestringrequired
503ServiceUnavailableError
_tagstringrequired
Allowed:ServiceUnavailableError
messagestringrequired
servicestring | any
Show properties
Any of:
string
string
any
any
Request
curl -X GET "/api/model"
Response
{
  "location": {
    "directory": "string",
    "workspaceID": {},
    "project": {
      "id": "string",
      "directory": "string"
    }
  },
  "data": [
    {
      "id": "string",
      "modelID": "string",
      "providerID": "string",
      "family": "string",
      "name": "string",
      "package": "string",
      "settings": {},
      "headers": {},
      "body": {},
      "capabilities": {
        "tools": true,
        "input": [
          "string"
        ],
        "output": [
          "string"
        ]
      },
      "variants": [
        {
          "id": "string",
          "settings": {},
          "headers": {},
          "body": {}
        }
      ],
      "time": {
        "released": 0
      },
      "cost": [
        {
          "tier": {
            "type": "context",
            "size": 0
          },
          "input": 0,
          "output": 0,
          "cache": {
            "read": 0,
            "write": 0
          }
        }
      ],
      "status": "alpha",
      "enabled": true,
      "limit": {
        "context": 0,
        "input": 0,
        "output": 0
      }
    }
  ]
}