Settings API

Configure and manage application settings in Gconv Prune

Overview

The Settings API allows you to manage application-wide configurations, user preferences, and system settings. This guide covers all available settings endpoints and their usage.

Application Settings

GET /v1/settings

Retrieve current application settings:

{
  "app_name": "My Gconv App",
  "theme": {
    "primary_color": "#4F46E5",
    "mode": "dark"
  },
  "features": {
    "chat": true,
    "file_upload": true,
    "code_completion": true
  },
  "limits": {
    "max_tokens": 4096,
    "max_requests_per_min": 60
  }
}

PATCH /v1/settings

Update application settings:

{
  "theme": {
    "mode": "light",
    "primary_color": "#2563EB"
  },
  "features": {
    "file_upload": false
  }
}

User Preferences

GET /v1/settings/preferences

Get user preferences:

{
  "language": "en",
  "timezone": "UTC",
  "notifications": {
    "email": true,
    "push": false
  },
  "display": {
    "theme": "dark",
    "font_size": "medium"
  }
}

API Configuration

Configure API settings:

POST /v1/settings/api

{
  "version": "v1",
  "rate_limiting": {
    "enabled": true,
    "requests_per_minute": 60
  },
  "cors": {
    "allowed_origins": ["https://yourdomain.com"],
    "allowed_methods": ["GET", "POST", "PATCH"]
  }
}

Need Help?

For more detailed information about the Settings API, check our API reference or contact our support team.