# Reference

<details><summary><code>client.<a href="/src/Client.ts">submitWorkflowExecutionActuals</a>({ ...params }) -> void</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

    Used to submit feedback regarding the quality of previous workflow execution and its outputs.

    **Note:** Uses a base url of `https://predict.vellum.ai`.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.submitWorkflowExecutionActuals({
    actuals: [
        {
            outputType: "STRING",
        },
        {
            outputType: "STRING",
        },
    ],
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.SubmitWorkflowExecutionActualsRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `VellumClient.RequestOptions`

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

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

##

## Integrations

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

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

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

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

</dd>
</dl>

<dl>
<dd>

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

</dd>
</dl>

<dl>
<dd>

**toolName:** `string` — The tool's unique name, as specified by the integration provider

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.RetrieveIntegrationToolDefinitionRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Integrations.RequestOptions`

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

</dd>
</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>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.integrations.executeIntegrationTool("integration_name", "integration_provider", "tool_name", {
    body: {
        provider: "COMPOSIO",
        arguments: {
            arguments: {
                key: "value",
            },
        },
    },
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

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

</dd>
</dl>

<dl>
<dd>

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

</dd>
</dl>

<dl>
<dd>

**toolName:** `string` — The tool's unique name, as specified by the integration provider

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.ExecuteIntegrationToolRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Integrations.RequestOptions`

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

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

<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">list</a>({ ...params }) -> Vellum.PaginatedSlimIntegrationReadList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all integrations

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.integrations.list();
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.IntegrationsListRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Integrations.RequestOptions`

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

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

<details><summary><code>client.integrations.<a href="/src/api/resources/integrations/client/Client.ts">retrieve</a>(id) -> Vellum.IntegrationRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve an integration

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.integrations.retrieve("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — A UUID string identifying this integration.

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Integrations.RequestOptions`

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

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

## Events

<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">create</a>({ ...params }) -> Vellum.EventCreateResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Accept an event or list of events and publish them to ClickHouse for analytics processing.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.events.create([
    {
        name: "node.execution.initiated",
        body: {
            nodeDefinition: {
                name: "name",
                module: ["module", "module"],
                id: "id",
            },
            inputs: {
                inputs: {
                    key: "value",
                },
            },
        },
        id: "id",
        timestamp: "2024-01-15T09:30:00Z",
        traceId: "trace_id",
        spanId: "span_id",
    },
    {
        name: "node.execution.initiated",
        body: {
            nodeDefinition: {
                name: "name",
                module: ["module", "module"],
                id: "id",
            },
            inputs: {
                inputs: {
                    key: "value",
                },
            },
        },
        id: "id",
        timestamp: "2024-01-15T09:30:00Z",
        traceId: "trace_id",
        spanId: "span_id",
    },
]);
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.CreateWorkflowEventRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Events.RequestOptions`

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

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

## AdHoc

<details><summary><code>client.adHoc.<a href="/src/api/resources/adHoc/client/Client.ts">adhocExecutePrompt</a>({ ...params }) -> Vellum.AdHocExecutePromptEvent</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.adHoc.adhocExecutePrompt({
    mlModel: "x",
    inputValues: [
        {
            name: "x",
            type: "STRING",
            value: "value",
        },
        {
            name: "x",
            type: "STRING",
            value: "value",
        },
    ],
    inputVariables: [
        {
            id: "x",
            key: "key",
            type: "STRING",
        },
        {
            id: "x",
            key: "key",
            type: "STRING",
        },
    ],
    parameters: {},
    blocks: [
        {
            blockType: "JINJA",
            template: "template",
        },
        {
            blockType: "JINJA",
            template: "template",
        },
    ],
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.AdHocExecutePrompt`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `AdHoc.RequestOptions`

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

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

<details><summary><code>client.adHoc.<a href="/src/api/resources/adHoc/client/Client.ts">adhocExecutePromptStream</a>({ ...params }) -> core.Stream&lt;Vellum.AdHocExecutePromptEvent&gt;</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
const response = await client.adHoc.adhocExecutePromptStream({
    mlModel: "x",
    inputValues: [
        {
            name: "x",
            type: "STRING",
            value: "value",
        },
        {
            name: "x",
            type: "STRING",
            value: "value",
        },
    ],
    inputVariables: [
        {
            id: "x",
            key: "key",
            type: "STRING",
        },
        {
            id: "x",
            key: "key",
            type: "STRING",
        },
    ],
    parameters: {},
    blocks: [
        {
            blockType: "JINJA",
            template: "template",
        },
        {
            blockType: "JINJA",
            template: "template",
        },
    ],
});
for await (const item of response) {
    console.log(item);
}
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.AdHocExecutePromptStream`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `AdHoc.RequestOptions`

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

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

## ContainerImages

<details><summary><code>client.containerImages.<a href="/src/api/resources/containerImages/client/Client.ts">list</a>({ ...params }) -> Vellum.PaginatedContainerImageReadList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a list of container images for the organization.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.containerImages.list();
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.ContainerImagesListRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `ContainerImages.RequestOptions`

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

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

<details><summary><code>client.containerImages.<a href="/src/api/resources/containerImages/client/Client.ts">createContainerImage</a>({ ...params }) -> Vellum.ContainerImageRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create a new Container Image.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.containerImages.createContainerImage({
    name: "x",
    packages: [
        {
            version: "x",
            name: "x",
        },
        {
            version: "x",
            name: "x",
        },
    ],
    tag: "x",
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.CreateContainerImageRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `ContainerImages.RequestOptions`

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

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

<details><summary><code>client.containerImages.<a href="/src/api/resources/containerImages/client/Client.ts">retrieve</a>(id) -> Vellum.ContainerImageRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a Container Image by its ID or name.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.containerImages.retrieve("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Container Image's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `ContainerImages.RequestOptions`

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

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

<details><summary><code>client.containerImages.<a href="/src/api/resources/containerImages/client/Client.ts">updateContainerImage</a>(id, { ...params }) -> Vellum.ContainerImageRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update an existing Container Image.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.containerImages.updateContainerImage("id", {
    packages: [
        {
            version: "x",
            name: "x",
        },
        {
            version: "x",
            name: "x",
        },
    ],
    tag: "x",
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — A UUID string identifying this container image.

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.UpdateContainerImageRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `ContainerImages.RequestOptions`

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

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

<details><summary><code>client.containerImages.<a href="/src/api/resources/containerImages/client/Client.ts">dockerServiceToken</a>() -> Vellum.DockerServiceToken</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.containerImages.dockerServiceToken();
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**requestOptions:** `ContainerImages.RequestOptions`

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

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

<details><summary><code>client.containerImages.<a href="/src/api/resources/containerImages/client/Client.ts">pushContainerImage</a>({ ...params }) -> Vellum.ContainerImageRead</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.containerImages.pushContainerImage({
    name: "x",
    sha: "x",
    tags: ["tags", "tags"],
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.PushContainerImageRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `ContainerImages.RequestOptions`

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

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

## Deployments

<details><summary><code>client.deployments.<a href="/src/api/resources/deployments/client/Client.ts">list</a>({ ...params }) -> Vellum.PaginatedSlimDeploymentReadList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to list all Prompt Deployments.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.deployments.list();
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.DeploymentsListRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Deployments.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to retrieve a Prompt Deployment given its ID or name.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.deployments.retrieve("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Prompt Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Deployments.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the
`retrieve_prompt_deployment_release` xendpoint instead.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

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

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

#### ⚙️ Parameters

<dl>
<dd>

<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.

</dd>
</dl>

<dl>
<dd>

**id:** `string` — Either the Prompt Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Deployments.RequestOptions`

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

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

<details><summary><code>client.deployments.<a href="/src/api/resources/deployments/client/Client.ts">listDeploymentReleaseTags</a>(id, { ...params }) -> Vellum.PaginatedDeploymentReleaseTagReadList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List Release Tags associated with the specified Prompt Deployment

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.deployments.listDeploymentReleaseTags("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Prompt Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.ListDeploymentReleaseTagsRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Deployments.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a Deployment Release Tag by tag name, associated with a specified Deployment.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.deployments.retrieveDeploymentReleaseTag("id", "name");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Prompt Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**name:** `string` — The name of the Release Tag associated with this Deployment that you'd like to retrieve.

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Deployments.RequestOptions`

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

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

<details><summary><code>client.deployments.<a href="/src/api/resources/deployments/client/Client.ts">updateDeploymentReleaseTag</a>(id, name, { ...params }) -> Vellum.DeploymentReleaseTagRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates an existing Release Tag associated with the specified Prompt Deployment.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.deployments.updateDeploymentReleaseTag("id", "name");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Prompt Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**name:** `string` — The name of the Release Tag associated with this Deployment that you'd like to update.

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.PatchedDeploymentReleaseTagUpdateRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Deployments.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a specific Prompt Deployment Release by either its UUID or the name of a Release Tag that points to it.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.deployments.retrievePromptDeploymentRelease("id", "release_id_or_release_tag");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Prompt Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**releaseIdOrReleaseTag:** `string` — Either the UUID of Prompt Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Prompt Deployment Release you'd like to retrieve.

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Deployments.RequestOptions`

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

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

<details><summary><code>client.deployments.<a href="/src/api/resources/deployments/client/Client.ts">retrieveProviderPayload</a>({ ...params }) -> Vellum.DeploymentProviderPayloadResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Given a set of input variable values, compile the exact payload that Vellum would send to the configured model provider
for execution if the execute-prompt endpoint had been invoked. Note that this endpoint does not actually execute the
prompt or make an API call to the model provider.

This endpoint is useful if you don't want to proxy LLM provider requests through Vellum and prefer to send them directly
to the provider yourself. Note that no guarantees are made on the format of this API's response schema, other than
that it will be a valid payload for the configured model provider. It's not recommended that you try to parse or
derive meaning from the response body and instead, should simply pass it directly to the model provider as is.

We encourage you to seek advise from Vellum Support before integrating with this API for production use.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.deployments.retrieveProviderPayload({
    inputs: [
        {
            name: "x",
            type: "STRING",
            value: "value",
        },
        {
            name: "x",
            type: "STRING",
            value: "value",
        },
    ],
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.DeploymentProviderPayloadRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Deployments.RequestOptions`

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

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

## DocumentIndexes

<details><summary><code>client.documentIndexes.<a href="/src/api/resources/documentIndexes/client/Client.ts">list</a>({ ...params }) -> Vellum.PaginatedDocumentIndexReadList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to retrieve a list of Document Indexes.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.documentIndexes.list();
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.DocumentIndexesListRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `DocumentIndexes.RequestOptions`

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

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

<details><summary><code>client.documentIndexes.<a href="/src/api/resources/documentIndexes/client/Client.ts">create</a>({ ...params }) -> Vellum.DocumentIndexRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a new document index.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.documentIndexes.create({
    label: "x",
    name: "x",
    indexingConfig: {
        vectorizer: {
            config: {},
            modelName: "text-embedding-3-small",
        },
    },
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.DocumentIndexCreateRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `DocumentIndexes.RequestOptions`

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

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

<details><summary><code>client.documentIndexes.<a href="/src/api/resources/documentIndexes/client/Client.ts">retrieve</a>(id, { ...params }) -> Vellum.DocumentIndexRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to retrieve a Document Index given its ID or name.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.documentIndexes.retrieve("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Document Index's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.DocumentIndexesRetrieveRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `DocumentIndexes.RequestOptions`

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

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

<details><summary><code>client.documentIndexes.<a href="/src/api/resources/documentIndexes/client/Client.ts">update</a>(id, { ...params }) -> Vellum.DocumentIndexRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to fully update a Document Index given its ID or name.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.documentIndexes.update("id", {
    label: "x",
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Document Index's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.DocumentIndexUpdateRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `DocumentIndexes.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to delete a Document Index given its ID or name.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.documentIndexes.destroy("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Document Index's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `DocumentIndexes.RequestOptions`

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

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

<details><summary><code>client.documentIndexes.<a href="/src/api/resources/documentIndexes/client/Client.ts">partialUpdate</a>(id, { ...params }) -> Vellum.DocumentIndexRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to partial update a Document Index given its ID or name.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.documentIndexes.partialUpdate("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Document Index's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.PatchedDocumentIndexUpdateRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `DocumentIndexes.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Adds a previously uploaded Document to the specified Document Index.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

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

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

#### ⚙️ Parameters

<dl>
<dd>

<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.

</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.

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `DocumentIndexes.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Removes a Document from a Document Index without deleting the Document itself.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

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

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

#### ⚙️ Parameters

<dl>
<dd>

<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.

</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.

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `DocumentIndexes.RequestOptions`

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

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

## Documents

<details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">list</a>({ ...params }) -> Vellum.PaginatedSlimDocumentList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to list documents. Optionally filter on supported fields.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.documents.list();
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.DocumentsListRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Documents.RequestOptions`

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

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

<details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">retrieve</a>(id) -> Vellum.DocumentRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a Document, keying off of either its Vellum-generated ID or its external ID.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.documents.retrieve("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Documents.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete a Document, keying off of either its Vellum-generated ID or its external ID.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.documents.destroy("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Documents.RequestOptions`

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

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

<details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">partialUpdate</a>(id, { ...params }) -> Vellum.DocumentRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a Document, keying off of either its Vellum-generated ID or its external ID. Particularly useful for updating its metadata.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.documents.partialUpdate("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string`

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.PatchedDocumentUpdateRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Documents.RequestOptions`

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

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

## Environments

<details><summary><code>client.environments.<a href="/src/api/resources/environments/client/Client.ts">environmentIdentity</a>() -> Vellum.EnvironmentRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieves information about the active Environment

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.environments.environmentIdentity();
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**requestOptions:** `Environments.RequestOptions`

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

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

## FolderEntities

<details><summary><code>client.folderEntities.<a href="/src/api/resources/folderEntities/client/Client.ts">list</a>({ ...params }) -> Vellum.PaginatedFolderEntityList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all folder entities within a specified folder.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.folderEntities.list({
    parentFolderId: "parent_folder_id",
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.FolderEntitiesListRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `FolderEntities.RequestOptions`

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

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

<details><summary><code>client.folderEntities.<a href="/src/api/resources/folderEntities/client/Client.ts">addEntityToFolder</a>(folderId, { ...params }) -> void</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Add an entity to a specific folder or root directory.

Adding an entity to a folder will remove it from any other folders it might have been a member of.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.folderEntities.addEntityToFolder("folder_id", {
    entityId: "entity_id",
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**folderId:** `string`

The ID of the folder to which the entity should be added. This can be a UUID of a folder, or the name of a root
directory. Supported root directories include:

- PROMPT_SANDBOX
- WORKFLOW_SANDBOX
- DOCUMENT_INDEX
- TEST_SUITE

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.AddEntityToFolderRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `FolderEntities.RequestOptions`

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

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

## IntegrationAuthConfigs

<details><summary><code>client.integrationAuthConfigs.<a href="/src/api/resources/integrationAuthConfigs/client/Client.ts">listIntegrationAuthConfigs</a>({ ...params }) -> Vellum.PaginatedSlimIntegrationAuthConfigReadList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List Integration Auth Configs

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.integrationAuthConfigs.listIntegrationAuthConfigs();
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.ListIntegrationAuthConfigsRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `IntegrationAuthConfigs.RequestOptions`

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

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

## IntegrationProviders

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a specific integration tool definition.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.integrationProviders.retrieveIntegrationProviderToolDefinition(
    "integration_name",
    "integration_provider",
    "tool_name",
);
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

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

</dd>
</dl>

<dl>
<dd>

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

</dd>
</dl>

<dl>
<dd>

**toolName:** `string` — The tool's unique name, as specified by the integration provider

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.RetrieveIntegrationProviderToolDefinitionRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `IntegrationProviders.RequestOptions`

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

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

<details><summary><code>client.integrationProviders.<a href="/src/api/resources/integrationProviders/client/Client.ts">listIntegrationTools</a>(integrationProvider, { ...params }) -> Vellum.PaginatedSlimToolDefinitionList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all integration tools for a given provider and integration.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.integrationProviders.listIntegrationTools("integration_provider");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

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

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.ListIntegrationToolsRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `IntegrationProviders.RequestOptions`

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

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

## MetricDefinitions

<details><summary><code>client.metricDefinitions.<a href="/src/api/resources/metricDefinitions/client/Client.ts">executeMetricDefinition</a>(id, { ...params }) -> Vellum.MetricDefinitionExecution</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.metricDefinitions.executeMetricDefinition("id", {
    inputs: [
        {
            name: "x",
            type: "STRING",
            value: "value",
        },
        {
            name: "x",
            type: "STRING",
            value: "value",
        },
    ],
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Metric Definition's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.ExecuteMetricDefinition`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `MetricDefinitions.RequestOptions`

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

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

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

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

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

#### ⚙️ Parameters

<dl>
<dd>

<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.

</dd>
</dl>

<dl>
<dd>

**id:** `string` — A UUID string identifying this metric definition.

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `MetricDefinitions.RequestOptions`

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

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

## MlModels

<details><summary><code>client.mlModels.<a href="/src/api/resources/mlModels/client/Client.ts">retrieve</a>(id) -> Vellum.MlModelRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve details about an ML Model

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.mlModels.retrieve("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the ML Model's ID, its unique name, or its ID in the workspace.

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `MlModels.RequestOptions`

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

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

## Organizations

<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">organizationIdentity</a>() -> Vellum.OrganizationRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieves information about the active Organization

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.organizations.organizationIdentity();
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**requestOptions:** `Organizations.RequestOptions`

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

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

## Prompts

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to pull the definition of a Prompt from Vellum.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

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

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — The ID of the Prompt to pull from. Prompt Sandbox IDs are currently supported.

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.PromptsPullRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Prompts.RequestOptions`

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

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

<details><summary><code>client.prompts.<a href="/src/api/resources/prompts/client/Client.ts">push</a>({ ...params }) -> Vellum.PromptPushResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to push updates to a Prompt in Vellum.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.prompts.push({
    execConfig: {
        mlModel: "ml_model",
        inputVariables: [
            {
                id: "x",
                key: "key",
                type: "STRING",
            },
            {
                id: "x",
                key: "key",
                type: "STRING",
            },
        ],
        parameters: {},
        blocks: [
            {
                blockType: "JINJA",
                template: "template",
            },
            {
                blockType: "JINJA",
                template: "template",
            },
        ],
    },
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.PromptPush`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Prompts.RequestOptions`

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

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

## Sandboxes

<details><summary><code>client.sandboxes.<a href="/src/api/resources/sandboxes/client/Client.ts">deployPrompt</a>(id, promptVariantId, { ...params }) -> Vellum.DeploymentRead</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.sandboxes.deployPrompt("id", "prompt_variant_id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — A UUID string identifying this sandbox.

</dd>
</dl>

<dl>
<dd>

**promptVariantId:** `string` — An ID identifying the Prompt you'd like to deploy.

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.DeploySandboxPromptRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Sandboxes.RequestOptions`

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

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

<details><summary><code>client.sandboxes.<a href="/src/api/resources/sandboxes/client/Client.ts">upsertSandboxScenario</a>(id, { ...params }) -> Vellum.SandboxScenario</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Upserts a new scenario for a sandbox, keying off of the optionally provided scenario id.

If an id is provided and has a match, the scenario will be updated. If no id is provided or no match
is found, a new scenario will be appended to the end.

Note that a full replacement of the scenario is performed, so any fields not provided will be removed
or overwritten with default values.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.sandboxes.upsertSandboxScenario("id", {
    inputs: [
        {
            type: "STRING",
            name: "x",
        },
        {
            type: "STRING",
            name: "x",
        },
    ],
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — A UUID string identifying this sandbox.

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.UpsertSandboxScenarioRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Sandboxes.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes an existing scenario from a sandbox, keying off of the provided scenario id.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.sandboxes.deleteSandboxScenario("id", "scenario_id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — A UUID string identifying this sandbox.

</dd>
</dl>

<dl>
<dd>

**scenarioId:** `string` — An id identifying the scenario that you'd like to delete

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Sandboxes.RequestOptions`

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

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

## TestSuiteRuns

<details><summary><code>client.testSuiteRuns.<a href="/src/api/resources/testSuiteRuns/client/Client.ts">create</a>({ ...params }) -> Vellum.TestSuiteRunRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Trigger a Test Suite and create a new Test Suite Run

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.testSuiteRuns.create({
    execConfig: {
        type: "DEPLOYMENT_RELEASE_TAG",
        data: {
            deploymentId: "deployment_id",
        },
    },
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.TestSuiteRunCreateRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `TestSuiteRuns.RequestOptions`

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

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

<details><summary><code>client.testSuiteRuns.<a href="/src/api/resources/testSuiteRuns/client/Client.ts">retrieve</a>(id) -> Vellum.TestSuiteRunRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a specific Test Suite Run by ID

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.testSuiteRuns.retrieve("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — A UUID string identifying this test suite run.

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `TestSuiteRuns.RequestOptions`

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

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

<details><summary><code>client.testSuiteRuns.<a href="/src/api/resources/testSuiteRuns/client/Client.ts">listExecutions</a>(id, { ...params }) -> Vellum.PaginatedTestSuiteRunExecutionList</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.testSuiteRuns.listExecutions("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — A UUID string identifying this test suite run.

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.TestSuiteRunsListExecutionsRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `TestSuiteRuns.RequestOptions`

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

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

## TestSuites

<details><summary><code>client.testSuites.<a href="/src/api/resources/testSuites/client/Client.ts">listTestSuiteTestCases</a>(id, { ...params }) -> Vellum.PaginatedTestSuiteTestCaseList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List the Test Cases associated with a Test Suite

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.testSuites.listTestSuiteTestCases("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Test Suites' ID or its unique name

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.ListTestSuiteTestCasesRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `TestSuites.RequestOptions`

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

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

<details><summary><code>client.testSuites.<a href="/src/api/resources/testSuites/client/Client.ts">upsertTestSuiteTestCase</a>(id, { ...params }) -> Vellum.TestSuiteTestCase</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Upserts a new test case for a test suite, keying off of the optionally provided test case id.

If an id is provided and has a match, the test case will be updated. If no id is provided or no match
is found, a new test case will be appended to the end.

Note that a full replacement of the test case is performed, so any fields not provided will be removed
or overwritten with default values.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.testSuites.upsertTestSuiteTestCase("id", {
    inputValues: [
        {
            type: "STRING",
            name: "x",
        },
        {
            type: "STRING",
            name: "x",
        },
    ],
    evaluationValues: [
        {
            type: "STRING",
            name: "x",
        },
        {
            type: "STRING",
            name: "x",
        },
    ],
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Test Suites' ID or its unique name

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.UpsertTestSuiteTestCaseRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `TestSuites.RequestOptions`

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

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

<details><summary><code>client.testSuites.<a href="/src/api/resources/testSuites/client/Client.ts">testSuiteTestCasesBulk</a>(id, { ...params }) -> core.Stream&lt;Vellum.TestSuiteTestCaseBulkResult[]&gt;</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Created, replace, and delete Test Cases within the specified Test Suite in bulk

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
const response = await client.testSuites.testSuiteTestCasesBulk("id", [
    {
        id: "id",
        type: "CREATE",
        data: {
            inputValues: [
                {
                    type: "STRING",
                    name: "x",
                },
                {
                    type: "STRING",
                    name: "x",
                },
            ],
            evaluationValues: [
                {
                    type: "STRING",
                    name: "x",
                },
                {
                    type: "STRING",
                    name: "x",
                },
            ],
        },
    },
    {
        id: "id",
        type: "CREATE",
        data: {
            inputValues: [
                {
                    type: "STRING",
                    name: "x",
                },
                {
                    type: "STRING",
                    name: "x",
                },
            ],
            evaluationValues: [
                {
                    type: "STRING",
                    name: "x",
                },
                {
                    type: "STRING",
                    name: "x",
                },
            ],
        },
    },
]);
for await (const item of response) {
    console.log(item);
}
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Test Suites' ID or its unique name

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.TestSuiteTestCaseBulkOperationRequest[]`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `TestSuites.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deletes an existing test case for a test suite, keying off of the test case id.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.testSuites.deleteTestSuiteTestCase("id", "test_case_id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Test Suites' ID or its unique name

</dd>
</dl>

<dl>
<dd>

**testCaseId:** `string` — An id identifying the test case that you'd like to delete

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `TestSuites.RequestOptions`

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

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

## UploadedFiles

<details><summary><code>client.uploadedFiles.<a href="/src/api/resources/uploadedFiles/client/Client.ts">retrieve</a>(id, { ...params }) -> Vellum.UploadedFileRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a previously uploaded file by its ID

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.uploadedFiles.retrieve("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — A UUID string identifying this uploaded file.

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.UploadedFilesRetrieveRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `UploadedFiles.RequestOptions`

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

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

## WorkflowDeployments

<details><summary><code>client.workflowDeployments.<a href="/src/api/resources/workflowDeployments/client/Client.ts">list</a>({ ...params }) -> Vellum.PaginatedSlimWorkflowDeploymentList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to list all Workflow Deployments.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflowDeployments.list();
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.WorkflowDeploymentsListRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowDeployments.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to retrieve a workflow deployment given its ID or name.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflowDeployments.retrieve("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Workflow Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowDeployments.RequestOptions`

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

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

<details><summary><code>client.workflowDeployments.<a href="/src/api/resources/workflowDeployments/client/Client.ts">executeStream</a>(id, { ...params }) -> core.Stream&lt;Vellum.WorkflowEvent&gt;</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Executes a deployed Workflow and streams back its results.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
const response = await client.workflowDeployments.executeStream("my-workflow", {
    inputs: {
        question: "What is the capital of France?",
    },
});
for await (const item of response) {
    console.log(item);
}
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Workflow Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.ExecuteWorkflowDeploymentStreamRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowDeployments.RequestOptions`

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

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

<details><summary><code>client.workflowDeployments.<a href="/src/api/resources/workflowDeployments/client/Client.ts">listWorkflowDeploymentEventExecutions</a>(id, { ...params }) -> Vellum.WorkflowDeploymentEventExecutionsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflowDeployments.listWorkflowDeploymentEventExecutions("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string`

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.ListWorkflowDeploymentEventExecutionsRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowDeployments.RequestOptions`

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

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

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

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

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**executionId:** `string`

</dd>
</dl>

<dl>
<dd>

**id:** `string`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowDeployments.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the
`retrieve_workflow_deployment_release` endpoint instead.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

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

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

#### ⚙️ Parameters

<dl>
<dd>

<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.

</dd>
</dl>

<dl>
<dd>

**id:** `string` — Either the Workflow Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowDeployments.RequestOptions`

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

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

<details><summary><code>client.workflowDeployments.<a href="/src/api/resources/workflowDeployments/client/Client.ts">listWorkflowReleaseTags</a>(id, { ...params }) -> Vellum.PaginatedWorkflowReleaseTagReadList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List Release Tags associated with the specified Workflow Deployment

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflowDeployments.listWorkflowReleaseTags("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Workflow Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.ListWorkflowReleaseTagsRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowDeployments.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a Workflow Release Tag by tag name, associated with a specified Workflow Deployment.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflowDeployments.retrieveWorkflowReleaseTag("id", "name");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Workflow Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**name:** `string` — The name of the Release Tag associated with this Workflow Deployment that you'd like to retrieve.

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowDeployments.RequestOptions`

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

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

<details><summary><code>client.workflowDeployments.<a href="/src/api/resources/workflowDeployments/client/Client.ts">updateWorkflowReleaseTag</a>(id, name, { ...params }) -> Vellum.WorkflowReleaseTagRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates an existing Release Tag associated with the specified Workflow Deployment.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflowDeployments.updateWorkflowReleaseTag("id", "name");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Workflow Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**name:** `string` — The name of the Release Tag associated with this Workflow Deployment that you'd like to update.

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.PatchedWorkflowReleaseTagUpdateRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowDeployments.RequestOptions`

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

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

<details><summary><code>client.workflowDeployments.<a href="/src/api/resources/workflowDeployments/client/Client.ts">listWorkflowDeploymentReleases</a>(id, { ...params }) -> Vellum.PaginatedWorkflowDeploymentReleaseList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List the Releases of the specified Workflow Deployment for the current Environment.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflowDeployments.listWorkflowDeploymentReleases("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Workflow Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.ListWorkflowDeploymentReleasesRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowDeployments.RequestOptions`

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

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

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a specific Workflow Deployment Release by either its UUID or the name of a Release Tag that points to it.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflowDeployments.retrieveWorkflowDeploymentRelease("id", "release_id_or_release_tag");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Workflow Deployment's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**releaseIdOrReleaseTag:** `string` — Either the UUID of Workflow Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Workflow Deployment Release you'd like to retrieve.

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowDeployments.RequestOptions`

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

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

## WorkflowExecutions

<details><summary><code>client.workflowExecutions.<a href="/src/api/resources/workflowExecutions/client/Client.ts">retrieveWorkflowExecutionDetail</a>(executionId, { ...params }) -> Vellum.WorkflowExecutionDetail</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflowExecutions.retrieveWorkflowExecutionDetail("execution_id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**executionId:** `string`

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.RetrieveWorkflowExecutionDetailRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowExecutions.RequestOptions`

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

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

## WorkflowSandboxes

<details><summary><code>client.workflowSandboxes.<a href="/src/api/resources/workflowSandboxes/client/Client.ts">deployWorkflow</a>(id, { ...params }) -> Vellum.WorkflowDeploymentRead</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflowSandboxes.deployWorkflow("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — A UUID string identifying this workflow sandbox.

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.DeploySandboxWorkflowRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowSandboxes.RequestOptions`

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

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

<details><summary><code>client.workflowSandboxes.<a href="/src/api/resources/workflowSandboxes/client/Client.ts">listWorkflowSandboxExamples</a>({ ...params }) -> Vellum.PaginatedWorkflowSandboxExampleList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List Workflow Sandbox examples that were previously cloned into the User's Workspace

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflowSandboxes.listWorkflowSandboxExamples();
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.ListWorkflowSandboxExamplesRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkflowSandboxes.RequestOptions`

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

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

## Workflows

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

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve the current state of a workflow execution.

**Note:** Uses a base url of `https://predict.vellum.ai`.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflows.retrieveState("span_id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**spanId:** `string` — The span ID of the workflow execution to retrieve state for

</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">executeNode</a>({ ...params }) -> Vellum.WorkflowSandboxExecuteNodeResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflows.executeNode({
    files: {
        files: "files",
    },
    node: "x",
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.WorkflowRunNodeRequest`

</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">workflowExecutionStatus</a>(executionId) -> Vellum.CheckWorkflowExecutionStatusResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Checks if a workflow execution is currently executing (not fulfilled, not rejected, and has no end time).
Uses the ClickHouse Prime summary materialized view.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflows.workflowExecutionStatus("execution_id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**executionId:** `string`

</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">serializeWorkflowFiles</a>({ ...params }) -> Record&lt;string, unknown&gt;</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Serialize files

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workflows.serializeWorkflowFiles({
    files: {
        files: {
            key: "value",
        },
    },
});
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Vellum.SerializeWorkflowFilesRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Workflows.RequestOptions`

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

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

## WorkspaceSecrets

<details><summary><code>client.workspaceSecrets.<a href="/src/api/resources/workspaceSecrets/client/Client.ts">retrieve</a>(id) -> Vellum.WorkspaceSecretRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to retrieve a Workspace Secret given its ID or name.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workspaceSecrets.retrieve("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Workspace Secret's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkspaceSecrets.RequestOptions`

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

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

<details><summary><code>client.workspaceSecrets.<a href="/src/api/resources/workspaceSecrets/client/Client.ts">partialUpdate</a>(id, { ...params }) -> Vellum.WorkspaceSecretRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Used to update a Workspace Secret given its ID or name.

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workspaceSecrets.partialUpdate("id");
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `string` — Either the Workspace Secret's ID or its unique name

</dd>
</dl>

<dl>
<dd>

**request:** `Vellum.PatchedWorkspaceSecretUpdateRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `WorkspaceSecrets.RequestOptions`

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

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

## Workspaces

<details><summary><code>client.workspaces.<a href="/src/api/resources/workspaces/client/Client.ts">workspaceIdentity</a>() -> Vellum.WorkspaceRead</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieves information about the active Workspace

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

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.workspaces.workspaceIdentity();
```

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

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**requestOptions:** `Workspaces.RequestOptions`

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

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