Files
Dorod-Sky/skyvern-ts/client/reference.md
2025-10-23 20:14:59 -06:00

142 lines
1.4 KiB
Markdown

# Reference
<details><summary><code>client.<a href="/src/Client.ts">deployScript</a>(scriptId, { ...params }) -> Skyvern.CreateScriptResponse</code></summary>
<dl>
<dd>
#### 📝 Description
<dl>
<dd>
<dl>
<dd>
Deploy a script with updated files, creating a new version
</dd>
</dl>
</dd>
</dl>
#### 🔌 Usage
<dl>
<dd>
<dl>
<dd>
```typescript
await client.deployScript("s_abc123", {
files: [{
path: "src/main.py",
content: "content"
}]
});
```
</dd>
</dl>
</dd>
</dl>
#### ⚙️ Parameters
<dl>
<dd>
<dl>
<dd>
**scriptId:** `string` — The unique identifier of the script
</dd>
</dl>
<dl>
<dd>
**request:** `Skyvern.DeployScriptRequest`
</dd>
</dl>
<dl>
<dd>
**requestOptions:** `SkyvernClient.RequestOptions`
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</details>
##
## Scripts
<details><summary><code>client.scripts.<a href="/src/api/resources/scripts/client/Client.ts">runScript</a>(scriptId) -> unknown</code></summary>
<dl>
<dd>
#### 📝 Description
<dl>
<dd>
<dl>
<dd>
Run a script
</dd>
</dl>
</dd>
</dl>
#### 🔌 Usage
<dl>
<dd>
<dl>
<dd>
```typescript
await client.scripts.runScript("s_abc123");
```
</dd>
</dl>
</dd>
</dl>
#### ⚙️ Parameters
<dl>
<dd>
<dl>
<dd>
**scriptId:** `string` — The unique identifier of the script
</dd>
</dl>
<dl>
<dd>
**requestOptions:** `Scripts.RequestOptions`
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</details>