Gets the default agent options for a personal or custom agent.

GET

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

GET

/api/v1/agents/defaults

curl -G https://api.awork.com/api/v1/agents/defaults \
     -H "Authorization: Bearer <token>" \
     -d type=type

{
  "type": "custom-agent",
  "modelProvider": "openai",
  "modelName": "gpt-5.6-terra",
  "presetKey": "balanced",
  "reasoningLevel": "medium",
  "toolAccess": {
    "awork": true,
    "webSearch": true,
    "googleGenAi": false,
    "openAiImageGeneration": false,
    "availableImageCapabilities": [
      "string"
    ]
  },
  "connectorIds": [
    "string"
  ],
  "skillIds": [
    "string"
  ],
  "availableModels": {
    "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 default model, tool access, connector, and skill options for a personal-agent or custom-agent conversation. Set type to ‘personal-agent’ for the requesting user’s defaults, or ‘custom-agent’ and provide agentId for a custom agent. The response also includes the effective model catalog for the workspace.

Required Permissions

The user must have read access to the selected custom agent.

Returns default model, tool access, connector, and skill options for a personal-agent or custom-agent conversation. Set type to 'personal-agent' for the requesting user's defaults, or 'custom-agent' and provide agentId for a custom agent. The response also includes the effective model catalog for the workspace. <Check title="Required Permissions" icon="key">The user must have read access to the selected custom agent.</Check>

Authentication

AuthorizationBearer

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

Query parameters

typestringRequired

The agent type to resolve defaults for (‘personal-agent’ or ‘custom-agent’).

agentIdstringOptionalformat: "uuid"

The id of the custom agent when is ‘custom-agent’.

Response

typestring or nullOptional

The matching agent thread type.

modelProviderstring or nullOptional

The default model provider.

modelNamestring or nullOptional

The default model name.

presetKeystring or nullOptional

The stored preset identity for preset-based agents.

reasoningLevelstring or nullOptional

The default reasoning level.

toolAccessobjectOptional

Represents default agent tool access settings.

connectorIdslist of strings or nullOptional

The default connector ids.

skillIdslist of strings or nullOptional

The default skill ids.

availableModelsobjectOptional

Describes the models available to the workspace.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error