InstanceSetting_AIProviderConfig

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

Referenced by these component schemas:

• InstanceSetting_AISetting

Shape and fields

object

AIProviderConfig represents one callable AI provider connection.

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "type": {
      "enum": [
        "AI_PROVIDER_TYPE_UNSPECIFIED",
        "OPENAI",
        "GEMINI"
      ],
      "type": "string",
      "format": "enum"
    },
    "endpoint": {
      "type": "string"
    },
    "apiKey": {
      "writeOnly": true,
      "type": "string",
      "description": "api_key is write-only and is never returned by GetInstanceSetting."
    },
    "apiKeySet": {
      "readOnly": true,
      "type": "boolean",
      "description": "api_key_set indicates whether an API key is stored for this provider."
    },
    "apiKeyHint": {
      "readOnly": true,
      "type": "string",
      "description": "api_key_hint is a masked hint for the stored API key."
    }
  },
  "description": "AIProviderConfig represents one callable AI provider connection."
}