> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.vellum.ai/developers/client-sdk/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.vellum.ai/_mcp/server. # Client SDK ## Docs - [Client SDK & API Reference](https://docs.vellum.ai/developers/client-sdk/introduction.md): Dive into Vellum's API docs for endpoint details, parameters, and responses. Use our official Python, Node, or Go clients for stable interaction. - [Authentication](https://docs.vellum.ai/developers/client-sdk/authentication.md): Learn how to authenticate with the Vellum API using API tokens. - [API Versioning](https://docs.vellum.ai/developers/client-sdk/api-versioning.md): Learn how to use Vellum's X-API-VERSION header to control which version of the API you're using and manage breaking changes. ## API Docs - Client SDK > Prompts [Execute Prompt](https://docs.vellum.ai/developers/client-sdk/prompts/execute-prompt.md) - Client SDK > Prompts [Execute Prompt as Stream](https://docs.vellum.ai/developers/client-sdk/prompts/execute-prompt-stream.md) - Client SDK > Prompts [Submit Prompt Execution Actuals](https://docs.vellum.ai/developers/client-sdk/prompts/submit-completion-actuals.md) - Client SDK > Prompts [Retrieve Provider Payload](https://docs.vellum.ai/developers/client-sdk/prompts/retrieve-provider-payload.md) - Client SDK > Prompts [Pull Prompt](https://docs.vellum.ai/developers/client-sdk/prompts/pull.md) - Client SDK > Prompts > Prompt Sandboxes [Deploy Prompt Sandbox](https://docs.vellum.ai/developers/client-sdk/prompts/sandboxes/deploy-prompt.md) - Client SDK > Prompts > Prompt Sandboxes [Upsert Prompt Sandbox Scenario](https://docs.vellum.ai/developers/client-sdk/prompts/sandboxes/upsert-scenario.md) - Client SDK > Prompts > Prompt Sandboxes [Delete Prompt Sandbox Scenario](https://docs.vellum.ai/developers/client-sdk/prompts/sandboxes/delete-scenario.md) - Client SDK > Prompts > Prompt Deployments [List Prompt Deployments](https://docs.vellum.ai/developers/client-sdk/prompts/deployments/list.md) - Client SDK > Prompts > Prompt Deployments [Retrieve Prompt Deployment](https://docs.vellum.ai/developers/client-sdk/prompts/deployments/retrieve.md) - Client SDK > Prompts > Prompt Deployments [Retrieve Prompt Deployment Release](https://docs.vellum.ai/developers/client-sdk/prompts/deployments/retrieve-release.md) - Client SDK > Prompts > Prompt Deployments [Retrieve Prompt Deployment Release Tag](https://docs.vellum.ai/developers/client-sdk/prompts/deployments/retrieve-release-tag.md) - Client SDK > Prompts > Prompt Deployments [List Prompt Deployment Release Tags](https://docs.vellum.ai/developers/client-sdk/prompts/deployments/list-release-tags.md) - Client SDK > Prompts > Prompt Deployments [Update Prompt Deployment Release Tag](https://docs.vellum.ai/developers/client-sdk/prompts/deployments/update-release-tag.md) - Client SDK > Prompts > Prompt Deployments [Retrieve Prompt Deployment History](https://docs.vellum.ai/developers/client-sdk/prompts/deployments/retrieve-history.md) - Client SDK > Workflows [Execute Workflow](https://docs.vellum.ai/developers/client-sdk/workflows/execute-workflow.md) - Client SDK > Workflows [Execute Workflow Async](https://docs.vellum.ai/developers/client-sdk/workflows/execute-workflow-async.md) - Client SDK > Workflows [Execute Workflow as Stream](https://docs.vellum.ai/developers/client-sdk/workflows/execute-workflow-stream.md) - Client SDK > Workflows [Check Workflow Execution Status](https://docs.vellum.ai/developers/client-sdk/workflows/check-execution-status.md) - Client SDK > Workflows [Submit Workflow Execution Actuals](https://docs.vellum.ai/developers/client-sdk/workflows/submit-workflow-execution-actuals.md) - Client SDK > Workflows [Pull Workflow](https://docs.vellum.ai/developers/client-sdk/workflows/pull.md) - Client SDK > Workflows > Workflow Sandboxes [Deploy Workflow](https://docs.vellum.ai/developers/client-sdk/workflows/sandboxes/deploy.md) - Client SDK > Workflows > Workflow Deployments [Execute Workflow Deployment as Stream](https://docs.vellum.ai/developers/client-sdk/workflows/deployments/execute-stream.md) - Client SDK > Workflows > Workflow Deployments [List Workflow Deployments](https://docs.vellum.ai/developers/client-sdk/workflows/deployments/list.md) - Client SDK > Workflows > Workflow Deployments [List Workflow Deployment Releases](https://docs.vellum.ai/developers/client-sdk/workflows/deployments/list-releases.md) - Client SDK > Workflows > Workflow Deployments [Retrieve Workflow Deployment](https://docs.vellum.ai/developers/client-sdk/workflows/deployments/retrieve.md) - Client SDK > Workflows > Workflow Deployments [Retrieve Workflow Deployment Release](https://docs.vellum.ai/developers/client-sdk/workflows/deployments/retrieve-release.md) - Client SDK > Workflows > Workflow Deployments [Retrieve Workflow Deployment Release Tag](https://docs.vellum.ai/developers/client-sdk/workflows/deployments/retrieve-release-tag.md) - Client SDK > Workflows > Workflow Deployments [List Workflow Deployment Release Tags](https://docs.vellum.ai/developers/client-sdk/workflows/deployments/list-release-tags.md) - Client SDK > Workflows > Workflow Deployments [Update Workflow Deployment Release Tag](https://docs.vellum.ai/developers/client-sdk/workflows/deployments/update-release-tag.md) - Client SDK > Workflows > Workflow Deployments [Retrieve Workflow Deployment History](https://docs.vellum.ai/developers/client-sdk/workflows/deployments/retrieve-history.md) - Client SDK > Workflows > Workflow Deployments [List Workflow Deployment Executions](https://docs.vellum.ai/developers/client-sdk/workflows/deployments/list-executions.md) - Client SDK > Workflows > Workflow Deployments [Retrieve Workflow Deployment Execution](https://docs.vellum.ai/developers/client-sdk/workflows/deployments/retrieve-execution-event.md) - Client SDK > Workflows > Workflow Executions [Retrieve Workflow Execution Detail](https://docs.vellum.ai/developers/client-sdk/workflows/executions/retrieve-workflow-execution-detail.md) - Client SDK > Workflows > Workflow Executions [Create Monitoring Event](https://docs.vellum.ai/developers/client-sdk/workflows/executions/create-monitoring-event.md) - Client SDK > Document Indexes [Search](https://docs.vellum.ai/developers/client-sdk/document-indexes/search.md) - Client SDK > Document Indexes [Add Document](https://docs.vellum.ai/developers/client-sdk/document-indexes/add-document.md) - Client SDK > Document Indexes [Create Document Index](https://docs.vellum.ai/developers/client-sdk/document-indexes/create.md) - Client SDK > Document Indexes [Retrieve Document Index](https://docs.vellum.ai/developers/client-sdk/document-indexes/retrieve.md) - Client SDK > Document Indexes [List Document Indexes](https://docs.vellum.ai/developers/client-sdk/document-indexes/list.md) - Client SDK > Document Indexes [Update Document Index](https://docs.vellum.ai/developers/client-sdk/document-indexes/update.md) - Client SDK > Document Indexes [Replace Document Index](https://docs.vellum.ai/developers/client-sdk/document-indexes/replace.md) - Client SDK > Document Indexes [Destroy](https://docs.vellum.ai/developers/client-sdk/document-indexes/destroy.md) - Client SDK > Document Indexes [Remove Document](https://docs.vellum.ai/developers/client-sdk/document-indexes/remove-document.md) - Client SDK > Documents [Upload Document](https://docs.vellum.ai/developers/client-sdk/documents/upload-document.md) - Client SDK > Documents [Retrieve Document](https://docs.vellum.ai/developers/client-sdk/documents/retrieve.md) - Client SDK > Documents [List Documents](https://docs.vellum.ai/developers/client-sdk/documents/list.md) - Client SDK > Documents [Update Document](https://docs.vellum.ai/developers/client-sdk/documents/update.md) - Client SDK > Documents [Destroy](https://docs.vellum.ai/developers/client-sdk/documents/destroy.md) - Client SDK > Files [Retrieve Uploaded File](https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve.md) - Client SDK > Test Suites > Test Cases [List Test Cases](https://docs.vellum.ai/developers/client-sdk/test-suites/test-cases/list.md) - Client SDK > Test Suites > Test Cases [Upsert Test Cases](https://docs.vellum.ai/developers/client-sdk/test-suites/test-cases/upsert.md) - Client SDK > Test Suites > Test Cases [Bulk Update Test Cases](https://docs.vellum.ai/developers/client-sdk/test-suites/test-cases/bulk-update.md) - Client SDK > Test Suites > Test Cases [Delete Test Case](https://docs.vellum.ai/developers/client-sdk/test-suites/test-cases/delete.md) - Client SDK > Test Suites > Test Suite Runs [Create Test Suite Run](https://docs.vellum.ai/developers/client-sdk/test-suites/runs/create.md) - Client SDK > Test Suites > Test Suite Runs [Retrieve Test Suite Run](https://docs.vellum.ai/developers/client-sdk/test-suites/runs/retrieve.md) - Client SDK > Test Suites > Test Suite Runs [List Test Suite Executions](https://docs.vellum.ai/developers/client-sdk/test-suites/runs/list-executions.md) - Client SDK > Folders [Add Entity to Folder](https://docs.vellum.ai/developers/client-sdk/folders/add-entity-to-folder.md) - Client SDK > Folders [List Folder Entities](https://docs.vellum.ai/developers/client-sdk/folders/list-folder-entities.md) - Client SDK > Secrets [Retrieve Workspace Secret](https://docs.vellum.ai/developers/client-sdk/secrets/retrieve-workspace-secret.md) - Client SDK > Secrets [Update Workspace Secret](https://docs.vellum.ai/developers/client-sdk/secrets/update-workspace-secret.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.vellum.ai/developers/client-sdk/openapi.json) - [OpenAPI YAML](https://docs.vellum.ai/developers/client-sdk/openapi.yaml)