Skip to content

[PR PREVIEW - DO NOT MERGE] 🌿 Fern Regeneration -- November 11, 2025 #849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fern-api wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[PR PREVIEW - DO NOT MERGE] 🌿 Fern Regeneration -- November 11, 2025 #849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0d2717
SDK regeneration
fern-api[bot] Nov 11, 2025
425f448
Update SDK from 36b73a9
vellum-automation[bot] Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vellum-ai",
"version": "1.10.1",
"version": "1.10.2",
"private": false,
"repository": "https://github.com/vellum-ai/vellum-client-node",
"license": "MIT",
Expand Down
128 changes: 92 additions & 36 deletions reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ await client.submitWorkflowExecutionActuals({

## Integrations

<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">retrieveIntegrationToolDefinition</a>(integrationName, integrationProvider, toolName) -> Vellum.ComponentsSchemasComposioToolDefinition</code></summary>
<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">retrieveIntegrationToolDefinition</a>(integrationProvider, integrationName, toolName) -> Vellum.ComponentsSchemasComposioToolDefinition</code></summary>
<dl>
<dd>

Expand All @@ -91,7 +91,7 @@ await client.submitWorkflowExecutionActuals({
<dd>

```typescript
await client.integrations.retrieveIntegrationToolDefinition("integration_name", "integration_provider", "tool_name");
await client.integrations.retrieveIntegrationToolDefinition("integration_provider", "integration_name", "tool_name");
```

</dd>
Expand All @@ -107,15 +107,15 @@ await client.integrations.retrieveIntegrationToolDefinition("integration_name",
<dl>
<dd>

**integrationName:** `string` — The integration name
**integrationProvider:** `string` — The integration provider name

</dd>
</dl>

<dl>
<dd>

**integrationProvider:** `string` — The integration provider name
**integrationName:** `string` — The integration name

</dd>
</dl>
Expand All @@ -142,7 +142,7 @@ await client.integrations.retrieveIntegrationToolDefinition("integration_name",
</dl>
</details>

<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">executeIntegrationTool</a>(integrationName, integrationProvider, toolName, { ...params }) -> Vellum.ComponentsSchemasComposioExecuteToolResponse</code></summary>
<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">executeIntegrationTool</a>(integrationProvider, integrationName, toolName, { ...params }) -> Vellum.ComponentsSchemasComposioExecuteToolResponse</code></summary>
<dl>
<dd>

Expand All @@ -155,7 +155,7 @@ await client.integrations.retrieveIntegrationToolDefinition("integration_name",
<dd>

```typescript
await client.integrations.executeIntegrationTool("integration_name", "integration_provider", "tool_name", {
await client.integrations.executeIntegrationTool("integration_provider", "integration_name", "tool_name", {
provider: "COMPOSIO",
arguments: {
arguments: {
Expand All @@ -178,15 +178,15 @@ await client.integrations.executeIntegrationTool("integration_name", "integratio
<dl>
<dd>

**integrationName:** `string` — The integration name
**integrationProvider:** `string` — The integration provider name

</dd>
</dl>

<dl>
<dd>

**integrationProvider:** `string` — The integration provider name
**integrationName:** `string` — The integration name

</dd>
</dl>
Expand Down Expand Up @@ -974,7 +974,7 @@ await client.deployments.retrieve("id");
</dl>
</details>

<details><summary><code>client.deployments.<a href="/src/api/resources/deployments/client/Client.ts">deploymentHistoryItemRetrieve</a>(historyIdOrReleaseTag, id) -> Vellum.DeploymentHistoryItem</code></summary>
<details><summary><code>client.deployments.<a href="/src/api/resources/deployments/client/Client.ts">deploymentHistoryItemRetrieve</a>(id, historyIdOrReleaseTag) -> Vellum.DeploymentHistoryItem</code></summary>
<dl>
<dd>

Expand Down Expand Up @@ -1003,7 +1003,7 @@ DEPRECATED: This endpoint is deprecated and will be removed in a future release.
<dd>

```typescript
await client.deployments.deploymentHistoryItemRetrieve("history_id_or_release_tag", "id");
await client.deployments.deploymentHistoryItemRetrieve("id", "history_id_or_release_tag");
```

</dd>
Expand All @@ -1019,15 +1019,15 @@ await client.deployments.deploymentHistoryItemRetrieve("history_id_or_release_ta
<dl>
<dd>

**historyIdOrReleaseTag:** `string` — Either the UUID of Deployment History Item you'd like to retrieve, or the name of a Release Tag that's pointing to the Deployment History Item you'd like to retrieve.
**id:** `string` — Either the Prompt Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**id:** `string` — Either the Prompt Deployment's ID or its unique name
**historyIdOrReleaseTag:** `string` — Either the UUID of Deployment History Item you'd like to retrieve, or the name of a Release Tag that's pointing to the Deployment History Item you'd like to retrieve.

</dd>
</dl>
Expand Down Expand Up @@ -1838,7 +1838,7 @@ await client.documentIndexes.partialUpdate("id");
</dl>
</details>

<details><summary><code>client.documentIndexes.<a href="/src/api/resources/documentIndexes/client/Client.ts">addDocument</a>(documentId, id) -> void</code></summary>
<details><summary><code>client.documentIndexes.<a href="/src/api/resources/documentIndexes/client/Client.ts">addDocument</a>(id, documentId) -> void</code></summary>
<dl>
<dd>

Expand Down Expand Up @@ -1866,7 +1866,7 @@ Adds a previously uploaded Document to the specified Document Index.
<dd>

```typescript
await client.documentIndexes.addDocument("document_id", "id");
await client.documentIndexes.addDocument("id", "document_id");
```

</dd>
Expand All @@ -1882,15 +1882,15 @@ await client.documentIndexes.addDocument("document_id", "id");
<dl>
<dd>

**documentId:** `string` — Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to add.
**id:** `string` — Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index to which you'd like to add the Document.

</dd>
</dl>

<dl>
<dd>

**id:** `string` — Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index to which you'd like to add the Document.
**documentId:** `string` — Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to add.

</dd>
</dl>
Expand All @@ -1909,7 +1909,7 @@ await client.documentIndexes.addDocument("document_id", "id");
</dl>
</details>

<details><summary><code>client.documentIndexes.<a href="/src/api/resources/documentIndexes/client/Client.ts">removeDocument</a>(documentId, id) -> void</code></summary>
<details><summary><code>client.documentIndexes.<a href="/src/api/resources/documentIndexes/client/Client.ts">removeDocument</a>(id, documentId) -> void</code></summary>
<dl>
<dd>

Expand Down Expand Up @@ -1937,7 +1937,7 @@ Removes a Document from a Document Index without deleting the Document itself.
<dd>

```typescript
await client.documentIndexes.removeDocument("document_id", "id");
await client.documentIndexes.removeDocument("id", "document_id");
```

</dd>
Expand All @@ -1953,15 +1953,15 @@ await client.documentIndexes.removeDocument("document_id", "id");
<dl>
<dd>

**documentId:** `string` — Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to remove.
**id:** `string` — Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index from which you'd like to remove a Document.

</dd>
</dl>

<dl>
<dd>

**id:** `string` — Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index from which you'd like to remove a Document.
**documentId:** `string` — Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to remove.

</dd>
</dl>
Expand Down Expand Up @@ -2516,7 +2516,7 @@ await client.integrationAuthConfigs.listIntegrationAuthConfigs();

## IntegrationProviders

<details><summary><code>client.integrationProviders.<a href="/src/api/resources/integrationProviders/client/Client.ts">retrieveIntegrationProviderToolDefinition</a>(integrationName, integrationProvider, toolName) -> Vellum.ComponentsSchemasComposioToolDefinition</code></summary>
<details><summary><code>client.integrationProviders.<a href="/src/api/resources/integrationProviders/client/Client.ts">retrieveIntegrationProviderToolDefinition</a>(integrationProvider, integrationName, toolName) -> Vellum.ComponentsSchemasComposioToolDefinition</code></summary>
<dl>
<dd>

Expand Down Expand Up @@ -2545,8 +2545,8 @@ Retrieve a specific integration tool definition.

```typescript
await client.integrationProviders.retrieveIntegrationProviderToolDefinition(
"integration_name",
"integration_provider",
"integration_name",
"tool_name",
);
```
Expand All @@ -2564,15 +2564,15 @@ await client.integrationProviders.retrieveIntegrationProviderToolDefinition(
<dl>
<dd>

**integrationName:** `string` — The integration name
**integrationProvider:** `string` — The integration provider name

</dd>
</dl>

<dl>
<dd>

**integrationProvider:** `string` — The integration provider name
**integrationName:** `string` — The integration name

</dd>
</dl>
Expand Down Expand Up @@ -2741,7 +2741,7 @@ await client.metricDefinitions.executeMetricDefinition("id", {
</dl>
</details>

<details><summary><code>client.metricDefinitions.<a href="/src/api/resources/metricDefinitions/client/Client.ts">metricDefinitionHistoryItemRetrieve</a>(historyIdOrReleaseTag, id) -> Vellum.MetricDefinitionHistoryItem</code></summary>
<details><summary><code>client.metricDefinitions.<a href="/src/api/resources/metricDefinitions/client/Client.ts">metricDefinitionHistoryItemRetrieve</a>(id, historyIdOrReleaseTag) -> Vellum.MetricDefinitionHistoryItem</code></summary>
<dl>
<dd>

Expand All @@ -2754,7 +2754,7 @@ await client.metricDefinitions.executeMetricDefinition("id", {
<dd>

```typescript
await client.metricDefinitions.metricDefinitionHistoryItemRetrieve("history_id_or_release_tag", "id");
await client.metricDefinitions.metricDefinitionHistoryItemRetrieve("id", "history_id_or_release_tag");
```

</dd>
Expand All @@ -2770,15 +2770,15 @@ await client.metricDefinitions.metricDefinitionHistoryItemRetrieve("history_id_o
<dl>
<dd>

**historyIdOrReleaseTag:** `string` — Either the UUID of Metric Definition History Item you'd like to retrieve, or the name of a Release Tag that's pointing to the Metric Definition History Item you'd like to retrieve.
**id:** `string` — A UUID string identifying this metric definition.

</dd>
</dl>

<dl>
<dd>

**id:** `string` — A UUID string identifying this metric definition.
**historyIdOrReleaseTag:** `string` — Either the UUID of Metric Definition History Item you'd like to retrieve, or the name of a Release Tag that's pointing to the Metric Definition History Item you'd like to retrieve.

</dd>
</dl>
Expand Down Expand Up @@ -4051,7 +4051,7 @@ await client.workflowDeployments.listWorkflowDeploymentEventExecutions("id");
</dl>
</details>

<details><summary><code>client.workflowDeployments.<a href="/src/api/resources/workflowDeployments/client/Client.ts">workflowDeploymentEventExecution</a>(executionId, id) -> Vellum.WorkflowEventExecutionRead</code></summary>
<details><summary><code>client.workflowDeployments.<a href="/src/api/resources/workflowDeployments/client/Client.ts">workflowDeploymentEventExecution</a>(id, executionId) -> Vellum.WorkflowEventExecutionRead</code></summary>
<dl>
<dd>

Expand All @@ -4064,7 +4064,7 @@ await client.workflowDeployments.listWorkflowDeploymentEventExecutions("id");
<dd>

```typescript
await client.workflowDeployments.workflowDeploymentEventExecution("execution_id", "id");
await client.workflowDeployments.workflowDeploymentEventExecution("id", "execution_id");
```

</dd>
Expand All @@ -4080,15 +4080,15 @@ await client.workflowDeployments.workflowDeploymentEventExecution("execution_id"
<dl>
<dd>

**executionId:** `string`
**id:** `string`

</dd>
</dl>

<dl>
<dd>

**id:** `string`
**executionId:** `string`

</dd>
</dl>
Expand All @@ -4107,7 +4107,7 @@ await client.workflowDeployments.workflowDeploymentEventExecution("execution_id"
</dl>
</details>

<details><summary><code>client.workflowDeployments.<a href="/src/api/resources/workflowDeployments/client/Client.ts">workflowDeploymentHistoryItemRetrieve</a>(historyIdOrReleaseTag, id) -> Vellum.WorkflowDeploymentHistoryItem</code></summary>
<details><summary><code>client.workflowDeployments.<a href="/src/api/resources/workflowDeployments/client/Client.ts">workflowDeploymentHistoryItemRetrieve</a>(id, historyIdOrReleaseTag) -> Vellum.WorkflowDeploymentHistoryItem</code></summary>
<dl>
<dd>

Expand Down Expand Up @@ -4136,7 +4136,7 @@ DEPRECATED: This endpoint is deprecated and will be removed in a future release.
<dd>

```typescript
await client.workflowDeployments.workflowDeploymentHistoryItemRetrieve("history_id_or_release_tag", "id");
await client.workflowDeployments.workflowDeploymentHistoryItemRetrieve("id", "history_id_or_release_tag");
```

</dd>
Expand All @@ -4152,15 +4152,15 @@ await client.workflowDeployments.workflowDeploymentHistoryItemRetrieve("history_
<dl>
<dd>

**historyIdOrReleaseTag:** `string` — Either the UUID of Workflow Deployment History Item you'd like to retrieve, or the name of a Release Tag that's pointing to the Workflow Deployment History Item you'd like to retrieve.
**id:** `string` — Either the Workflow Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**id:** `string` — Either the Workflow Deployment's ID or its unique name
**historyIdOrReleaseTag:** `string` — Either the UUID of Workflow Deployment History Item you'd like to retrieve, or the name of a Release Tag that's pointing to the Workflow Deployment History Item you'd like to retrieve.

</dd>
</dl>
Expand Down Expand Up @@ -4723,6 +4723,62 @@ await client.workflowSandboxes.listWorkflowSandboxExamples();

## Workflows

<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">pull</a>(id, { ...params }) -> stream.Readable</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflows.pull("id");
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — The ID of the Workflow to pull from

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.WorkflowsPullRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Workflows.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">retrieveState</a>(spanId) -> Vellum.WorkflowResolvedState</code></summary>
<dl>
<dd>
Expand Down
Loading