Providers

Validate provider

Validates a persisted provider against current local configuration and enabled models.

post/api/providers/{providerId}/validate

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

providerIdstring required
Example:pro_123

Response

Provider validation completed.

validboolean required
reason'ok' | 'disabled' | 'no_enabled_models' | 'missing_default_model' | 'default_model_unresolved' | 'missing_credentials' | 'provider_api_error' required
messagestring required
defaultModelIdstring nullable required
defaultModelNamestring nullable required
availableModelCountinteger required

Example response

{
  "provider": {
    "id": "pro_123",
    "type": "openai",
    "displayName": "Provider",
    "enabled": true,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  },
  "valid": true,
  "reason": "ok",
  "message": "Provider configuration is valid."
}

Changes

No recorded changes to this operation across all 3 revisions of this API.