github/sim
1
0
Fork 0
mirror of https://github.com/simstudioai/sim.git synced 2026-02-03 03:04:57 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat(api): add dedicated api endpoint, update docs, update deploy modal

Browse Source
This commit is contained in:
waleed
2026-02-01 20:15:54 -08:00
parent c6357f7438
commit 2b29c8c258
39 changed files with 92 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/python-sdk/README.md
View File

@@ -17,7 +17,7 @@ from simstudio import SimStudioClient
# Initialize the client
client = SimStudioClient(
api_key=os.getenv("SIM_API_KEY", "your-api-key-here"),
base_url="https://sim.ai" # optional, defaults to https://sim.ai
base_url="https://api.sim.ai" # optional, defaults to https://api.sim.ai
)
# Execute a workflow
@@ -35,11 +35,11 @@ except Exception as error:
#### Constructor
```python
SimStudioClient(api_key: str, base_url: str = "https://sim.ai")
SimStudioClient(api_key: str, base_url: str = "https://api.sim.ai")
```
- `api_key` (str): Your Sim API key
- `base_url` (str, optional): Base URL for the Sim API (defaults to `https://sim.ai`)
- `base_url` (str, optional): Base URL for the Sim API (defaults to `https://api.sim.ai`)
#### Methods
@@ -364,7 +364,7 @@ from simstudio import SimStudioClient
# Using environment variables
client = SimStudioClient(
api_key=os.getenv("SIM_API_KEY"),
base_url=os.getenv("SIM_BASE_URL", "https://sim.ai")
base_url=os.getenv("SIM_BASE_URL", "https://api.sim.ai")
)
```

6
packages/python-sdk/simstudio/__init__.py
View File

@@ -87,10 +87,10 @@ class SimStudioClient:
Args:
api_key: Your Sim API key
base_url: Base URL for the Sim API (defaults to https://sim.ai)
base_url: Base URL for the Sim API (defaults to https://api.sim.ai)
"""
def __init__(self, api_key: str, base_url: str = "https://sim.ai"):
def __init__(self, api_key: str, base_url: str = "https://api.sim.ai"):
self.api_key = api_key
self.base_url = base_url.rstrip('/')
self._session = requests.Session()

4
packages/python-sdk/tests/test_client.py
View File

@@ -18,7 +18,7 @@ def test_simstudio_client_default_base_url():
"""Test SimStudioClient with default base URL."""
client = SimStudioClient(api_key="test-api-key")
assert client.api_key == "test-api-key"
assert client.base_url == "https://sim.ai"
assert client.base_url == "https://api.sim.ai"
def test_set_api_key():
@@ -51,7 +51,7 @@ def test_validate_workflow_returns_false_on_error(mock_get):
result = client.validate_workflow("test-workflow-id")
assert result is False
mock_get.assert_called_once_with("https://sim.ai/api/workflows/test-workflow-id/status")
mock_get.assert_called_once_with("https://api.sim.ai/api/workflows/test-workflow-id/status")
def test_simstudio_error():