mirror of
https://github.com/simstudioai/sim.git
synced 2026-09-24 15:45:35 +08:00
feat(domain): drop the 'studio' (#818)
* feat(domain): drop the * change all references for Sim Studio to Sim * change back license and notice * lint --------- Co-authored-by: waleedlatif <waleedlatif@waleedlatifs-MacBook-Pro.local>
This commit is contained in:
co-authored by
waleedlatif
parent
13608a8bbc
commit
ae43381d84
@@ -1,6 +1,6 @@
|
||||
# Sim Studio Python SDK
|
||||
# Sim Python SDK
|
||||
|
||||
The official Python SDK for [Sim Studio](https://simstudio.ai), allowing you to execute workflows programmatically from your Python applications.
|
||||
The official Python SDK for [Sim](https://sim.ai), allowing you to execute workflows programmatically from your Python applications.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -17,7 +17,7 @@ from simstudio import SimStudioClient
|
||||
# Initialize the client
|
||||
client = SimStudioClient(
|
||||
api_key=os.getenv("SIMSTUDIO_API_KEY", "your-api-key-here"),
|
||||
base_url="https://simstudio.ai" # optional, defaults to https://simstudio.ai
|
||||
base_url="https://sim.ai" # optional, defaults to https://sim.ai
|
||||
)
|
||||
|
||||
# Execute a workflow
|
||||
@@ -35,11 +35,11 @@ except Exception as error:
|
||||
#### Constructor
|
||||
|
||||
```python
|
||||
SimStudioClient(api_key: str, base_url: str = "https://simstudio.ai")
|
||||
SimStudioClient(api_key: str, base_url: str = "https://sim.ai")
|
||||
```
|
||||
|
||||
- `api_key` (str): Your Sim Studio API key
|
||||
- `base_url` (str, optional): Base URL for the Sim Studio API (defaults to `https://simstudio.ai`)
|
||||
- `api_key` (str): Your Sim API key
|
||||
- `base_url` (str, optional): Base URL for the Sim API (defaults to `https://sim.ai`)
|
||||
|
||||
#### Methods
|
||||
|
||||
@@ -261,7 +261,7 @@ from simstudio import SimStudioClient
|
||||
# Using environment variables
|
||||
client = SimStudioClient(
|
||||
api_key=os.getenv("SIMSTUDIO_API_KEY"),
|
||||
base_url=os.getenv("SIMSTUDIO_BASE_URL", "https://simstudio.ai")
|
||||
base_url=os.getenv("SIMSTUDIO_BASE_URL", "https://sim.ai")
|
||||
)
|
||||
```
|
||||
|
||||
@@ -314,7 +314,7 @@ for result in results:
|
||||
|
||||
## Getting Your API Key
|
||||
|
||||
1. Log in to your [Sim Studio](https://simstudio.ai) account
|
||||
1. Log in to your [Sim](https://sim.ai) account
|
||||
2. Navigate to your workflow
|
||||
3. Click on "Deploy" to deploy your workflow
|
||||
4. Select or create an API key during the deployment process
|
||||
|
||||
Reference in New Issue
Block a user