Returns the AI models available to agents.

GET

https://api.awork.com/api/v1/agents/models

GET

/api/v1/agents/models

curl https://api.awork.com/api/v1/agents/models \
     -H "Authorization: Bearer <token>"

{
  "defaultProvider": "openai",
  "defaultModel": "gpt-5.6-terra",
  "providers": [
    {
      "provider": "openai",
      "displayName": "OpenAI",
      "defaultModel": "gpt-5.6-terra",
      "models": [
        "string"
      ],
      "modelDetails": [
        {
          "id": "gpt-5.6-terra",
          "key": "openai:gpt-5.6-terra",
          "kind": "text",
          "vendorKey": "openai",
          "vendorCountry": "EU",
          "regionKey": "europe",
          "displayName": "GPT-5.6 Terra",
          "status": "active",
          "isNew": false,
          "isWorkspaceEnabled": true,
          "isInUse": true,
          "isAvailable": true,
          "disabledReason": "Its vendor or region is disabled.",
          "canToggle": true,
          "creditFactor": 1,
          "servedFrom": "Europe",
          "servingFlag": "🇪🇺",
          "supportsImageInput": true,
          "supportedReasoningLevels": [
            "string"
          ]
        }
      ]
    }
  ],
  "performanceLevels": [
    {
      "id": "balanced",
      "provider": "openai",
      "model": "gpt-5.6-terra",
      "reasoningLevel": "medium",
      "isDefault": true
    }
  ],
  "workspaceSettings": {
    "autoEnableNewModels": true,
    "vendors": [
      {
        "key": "openai",
        "displayName": "OpenAI",
        "country": "US",
        "isEnabled": true,
        "isNew": false,
        "canToggle": true,
        "disabledReason": "Its vendor or region is disabled."
      }
    ],
    "regions": [
      {
        "key": "openai",
        "displayName": "OpenAI",
        "country": "US",
        "isEnabled": true,
        "isNew": false,
        "canToggle": true,
        "disabledReason": "Its vendor or region is disabled."
      }
    ],
    "presets": [
      {
        "presetKey": "balanced",
        "isAuto": false,
        "modelKey": "openai:gpt-5.6-terra",
        "reasoningLevel": "medium",
        "modelStatus": "active",
        "warning": "This preset uses a deprecated model and remains visible for existing agents.",
        "error": "This preset model is disabled by workspace settings."
      }
    ],
    "models": [
      {
        "id": "gpt-5.6-terra",
        "key": "openai:gpt-5.6-terra",
        "kind": "text",
        "vendorKey": "openai",
        "vendorCountry": "EU",
        "regionKey": "europe",
        "displayName": "GPT-5.6 Terra",
        "status": "active",
        "isNew": false,
        "isWorkspaceEnabled": true,
        "isInUse": true,
        "isAvailable": true,
        "disabledReason": "Its vendor or region is disabled.",
        "canToggle": true,
        "creditFactor": 1,
        "servedFrom": "Europe",
        "servingFlag": "🇪🇺",
        "supportsImageInput": true,
        "supportedReasoningLevels": [
          "string"
        ]
      }
    ],
    "availableImageCapabilities": [
      "string"
    ]
  },
  "availableImageCapabilities": [
    "string"
  ]
}

Returns the agent model catalog with effective availability for the current workspace. The response includes model providers, model details, defaults, and available image capabilities. Use these values when selecting a model for an agent or conversation.

Required Permissions

Any authenticated user.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

defaultProviderstring or nullOptional

The default provider.

defaultModelstring or nullOptional

The default model.

providerslist of objects or nullOptional

The available providers and their models.

performanceLevelslist of objects or nullOptional

The predefined performance levels that resolve to available models.

workspaceSettingsobjectOptional

Represents effective workspace AI model policy.

availableImageCapabilitieslist of strings or nullOptional

Image capability keys available in this workspace.

Errors

401

Unauthorized Error