Model APIs

​

Requirements

• Send Authorization: Bearer <api_key>. Only Organization API Keys are supported; personal credentials and service account credentials are not.
• Send Content-Type: application/json for requests with a JSON body.
• Use the organization bound to the API key as organization_id.
• Use group IDs in groupIds. Both manually managed groups and SCIM groups are supported.

​

Key behavior

• Models are organized by scenario (scenarioType): general (general coding), experts (Experts), and qoderwork (QoderWork). Each scenario contains two kinds of targets whose visibility can be set independently: levels (level, for example auto or ultimate) and new models (modelKey).
• The levels and new models you can manage are those returned by List models. They vary by region and change as the model catalog is released. Do not hard-code level or modelKey values.
• Targets your organization has never configured are treated as all. The exception is targets first released after new-model default visibility was turned off; see Update new model default visibility.
• Deleting a group removes it from every list but does not change scope. Once a list becomes empty, a group target is hidden from the entire organization. Queries then return the original scope with empty groupIds.
• These APIs return the policies configured for your organization, not the models a specific user can ultimately see.

​

Visibility

​

Data models

​

Scenario

​

ModelPolicy

​

API reference

​

List models

​

Success response (200 OK)

{
  "scenarios": [
    {
      "scenarioType": "general",
      "levels": [
        {
          "level": "auto",
          "displayName": "Auto",
          "scope": "all",
          "groupIds": []
        },
        {
          "level": "ultimate",
          "displayName": "Ultimate",
          "scope": "none",
          "groupIds": []
        }
      ],
      "newModels": [
        {
          "modelKey": "example-model",
          "displayName": "Example Model",
          "scope": "group",
          "groupIds": ["1c8f3ee2-b970-4b61-93f9-f8be080ae945"]
        }
      ]
    },
    {
      "scenarioType": "experts",
      "levels": [],
      "newModels": []
    },
    {
      "scenarioType": "qoderwork",
      "levels": [],
      "newModels": []
    }
  ]
}

​

Batch update model policies

​

Request body

{
  "policies": [
    {
      "scenarioType": "general",
      "level": "ultimate",
      "scope": "all"
    },
    {
      "scenarioType": "experts",
      "modelKey": "example-model",
      "scope": "group",
      "groupIds": ["1c8f3ee2-b970-4b61-93f9-f8be080ae945"]
    },
    {
      "scenarioType": "qoderwork",
      "level": "premium",
      "scope": "none"
    }
  ]
}

• level or modelKey must exist in the corresponding scenario returned by List models.
• The same target must not appear more than once in a request.
• String fields are trimmed of leading and trailing whitespace. Empty strings in groupIds are dropped and duplicates are removed before validation. Every group must belong to the current organization.
• Each entry accepts only the 5 fields above. When copying entries from the list response, remove displayName and add scenarioType.

{
  "policies": [
    {
      "scenarioType": "qoderwork",
      "level": "premium",
      "scope": "none",
      "groupIds": []
    }
  ]
}

​

Get new model default visibility

​

Success response (200 OK)

{
  "defaultVisible": true
}

​

Update new model default visibility

​

Request body

{
  "defaultVisible": false
}

​

Errors