Files
Dorod-Sky/skyvern-ts/client/reference.md

211 lines
2.3 KiB
Markdown
Raw Normal View History

2025-10-23 20:14:59 -06:00
# Reference
<details><summary><code>client.<a href="/src/Client.ts">runSdkAction</a>({ ...params }) -> Skyvern.RunSdkActionResponse</code></summary>
2025-10-23 20:14:59 -06:00
<dl>
<dd>
#### 📝 Description
<dl>
<dd>
<dl>
<dd>
Execute a single SDK action with the specified parameters
2025-10-23 20:14:59 -06:00
</dd>
</dl>
</dd>
</dl>
#### 🔌 Usage
<dl>
<dd>
<dl>
<dd>
```typescript
await client.runSdkAction({
url: "url",
action: {
2025-11-07 12:30:43 -07:00
type: "ai_act"
}
2025-10-23 20:14:59 -06:00
});
```
</dd>
</dl>
</dd>
</dl>
#### ⚙️ Parameters
<dl>
<dd>
<dl>
<dd>
**request:** `Skyvern.RunSdkActionRequest`
2025-10-23 20:14:59 -06:00
</dd>
</dl>
<dl>
<dd>
**requestOptions:** `SkyvernClient.RequestOptions`
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</details>
##
2025-12-17 14:11:39 -07:00
## Workflows
<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">setWorkflowTemplateStatus</a>(workflowPermanentId, { ...params }) -> Record<string, unknown></code></summary>
<dl>
<dd>
#### 📝 Description
<dl>
<dd>
<dl>
<dd>
Set or unset a workflow as a template.
Template status is stored at the workflow_permanent_id level (not per-version),
meaning all versions of a workflow share the same template status.
</dd>
</dl>
</dd>
</dl>
#### 🔌 Usage
<dl>
<dd>
<dl>
<dd>
```typescript
await client.workflows.setWorkflowTemplateStatus("workflow_permanent_id", {
is_template: true
});
```
</dd>
</dl>
</dd>
</dl>
#### ⚙️ Parameters
<dl>
<dd>
<dl>
<dd>
**workflowPermanentId:** `string`
</dd>
</dl>
<dl>
<dd>
**request:** `Skyvern.SetWorkflowTemplateStatusV1WorkflowsWorkflowPermanentIdTemplatePutRequest`
</dd>
</dl>
<dl>
<dd>
**requestOptions:** `Workflows.RequestOptions`
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</details>
2025-10-23 20:14:59 -06:00
## 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>