You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/agent-studio/key-concepts/vault.mdx
+50Lines changed: 50 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,6 +82,56 @@ To add a provider, open **Vault → Add Provider** and paste your credentials.
82
82
83
83
<Spacersize="md" />
84
84
85
+
## Custom Models
86
+
87
+
You can now add **custom models** to the SmythOS platform directly through the Vault.
88
+
This feature lets you connect your own model servers or third-party hosted APIs, as long as they expose endpoints compatible with the **OpenAI SDK**.
89
+
90
+
### How it works
91
+
92
+
1. Go to **Vault → Custom Models**
93
+
2. Click **Add Custom Model**
94
+
3. Provide the required details:
95
+
-**Name**: The display name shown in the model list
96
+
-**Model ID**: Copy from your supported model (e.g., Grok, Together AI, etc.)
97
+
-**Base URL**: The API base endpoint (must be public, not localhost or private IP)
98
+
-**Provider**: Select **OpenAI-compatible**
99
+
-**API Key**: Add the provider key (e.g., from Grok)
100
+
-**Context Window**: Optional limit on context tokens
101
+
-**Fallback Model**: Used when the custom model is unreachable
102
+
103
+
<WarningCallouttitle="Important Security Note">
104
+
Local or private IP addresses (like `localhost`, `127.0.0.1`, `10.x.x.x`, or `172.x.x.x`) are **not allowed** for base URLs in the SaaS environment for security reasons.
105
+
Always use a public or hosted endpoint instead (e.g., Grok, Together AI, or a remote Colab server).
106
+
</WarningCallout>
107
+
108
+
Once saved, reload your **Builder** page to see the newly added custom model in your model list.
109
+
110
+
### Example: Adding a Grok model
111
+
112
+
```json
113
+
{
114
+
"name": "Model for Grok",
115
+
"model_id": "grok-1",
116
+
"base_url": "https://api.grok.ai/v1",
117
+
"provider": "OpenAI",
118
+
"api_key": "grk-1234abcd...",
119
+
"fallback_model": "gpt-4o-mini"
120
+
}
121
+
```
122
+
After saving, reload the Builder. Your custom model will appear at the top of the model list. You can now select it for testing or deployment just like built-in models.
123
+
124
+
<InfoCallouttitle="Compatibility">
125
+
Any model API compatible with the OpenAI schema (`/v1/chat/completions`, `/v1/completions`, etc.) will work with SmythOS custom models. This includes integrations built with `ollama.cpp`, `Grok`, `Together AI`, or even custom endpoints hosted on services like Google Colab (if properly exposed).
126
+
</InfoCallout>
127
+
128
+
### Managing Keys
129
+
130
+
Custom model API keys are stored securely in Vault.
131
+
You can reveal, edit, or remove them at any time from the model entry.
132
+
133
+
<Spacersize="md" />
134
+
85
135
## Enterprise platforms
86
136
87
137
If your team uses managed AI infrastructure, Vault supports enterprise providers too.
0 commit comments