Skip to content

Commit 74088e1

Browse files
committed
fix(docs): say the SDK default host redirects to www
1 parent fad5d3e commit 74088e1

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

‎apps/docs/content/docs/api-reference/python.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ from simstudio import SimStudioClient
3030
# Initialize the client
3131
client = SimStudioClient(
3232
api_key="your-api-key-here",
33-
base_url="https://www.sim.ai" # optional, defaults to https://sim.ai
33+
base_url="https://www.sim.ai" # optional; the default https://sim.ai redirects to this host
3434
)
3535

3636
# Execute a workflow
@@ -53,7 +53,7 @@ SimStudioClient(api_key: str, base_url: str = "https://sim.ai")
5353

5454
**Parameters:**
5555
- `api_key` (str): Your Sim API key
56-
- `base_url` (str, optional): Base URL for the Sim API
56+
- `base_url` (str, optional): Base URL for the Sim API (defaults to `https://sim.ai`, which redirects to `https://www.sim.ai`; set the `www` host explicitly)
5757

5858
#### Methods
5959

‎apps/docs/content/docs/api-reference/typescript.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ import { SimStudioClient } from 'simstudio-ts-sdk';
4444
// Initialize the client
4545
const client = new SimStudioClient({
4646
apiKey: 'your-api-key-here',
47-
baseUrl: 'https://www.sim.ai' // optional, defaults to https://sim.ai
47+
baseUrl: 'https://www.sim.ai' // optional; the default https://sim.ai redirects to this host
4848
});
4949

5050
// Execute a workflow
@@ -68,7 +68,7 @@ new SimStudioClient(config: SimStudioConfig)
6868

6969
**Configuration:**
7070
- `config.apiKey` (string): Your Sim API key
71-
- `config.baseUrl` (string, optional): Base URL for the Sim API (defaults to `https://sim.ai`)
71+
- `config.baseUrl` (string, optional): Base URL for the Sim API (defaults to `https://sim.ai`, which redirects to `https://www.sim.ai`; set the `www` host explicitly)
7272

7373
#### Methods
7474

0 commit comments

Comments
 (0)