---
title: "VaultSpeed SDK"
canonical: "https://docs.vaultspeed.com/space/VPD/3496575098/VaultSpeed%20SDK"
format: markdown
---
The VaultSpeed SDK is a Python interface (3.8+) for automating actions you can do in the UI: configure projects and parameters, model sources, create Data Vault and Business Vault releases, generate/deploy code, and work with Studio (signatures & templates).

This documentation describes how to use the SDK’s programmatic interface to interact with the VaultSpeed application.  
The SDK can perform most of the actions available in the UI.

> **Language & versions**
> 
> - Written for Python 3.8 or later
> - Documentation is also available as a Python notebook, allowing you to run the code step by step while reading.
> - Install [Project Jupyter](https://jupyter.org) to use the notebook.
> - Download it from our [VaultSpeed SDK GitHub repository](https://github.com/Vaultspeed/sdk), which also includes example DDL scripts in the **Resources** folder.

> 📝 **Note:** Code examples in this documentation are partial snippets. They will not work standalone — follow the topics in order and combine the examples to get working code.

## Quick links

### Install & first run

- [Installation Guide](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4609081361) – install `vaultspeed-sdk` from Artifacts and configure `pip.conf`/`pip.ini`
- [Getting started - SDK](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4608786522)– authenticate, create a client, and initialize `System`
- [Logging](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4609212427) – set log level for SDK scripts
- [SDK Structure ](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4687101993)– overview of main classes and their relationships

### Build a model (step by step)

- [Source](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4687364116) → **[Source Release]** → **[Second Source]**
- [Data Vault](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4609114135) → **[Data Vault Release]**
- [Business Vault](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4609605633)

### Generate & deploy

- [Generation](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4608720972) – DDL/ETL (full and delta)
- [FMC](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4609114163) – create, adjust, and generate FMC flows

### VaultSpeed Studio (SDK)

- [Signatures ](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4609048594)– layers, objects, attributes
- [Templates ](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4609572866)– create, edit, and test template-based objects

### Ready-made scripts

- [SDK Scripts](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4609212455)
  - [Generating and Deploying Code](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4609146907)
  - [Creating FMC Flows](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4609409162)
  - [Importing Signatures](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4609179678)
  - [Testing a Template](https://vaultspeed.atlassian.net/wiki/spaces/VPD/pages/4609048619)

---

## Helpful resources

- [VaultSpeed SDK GitHub repository](https://github.com/Vaultspeed/sdk) – scripts, notebook, and DDL examples
- [Project Jupyter ](https://jupyter.org)– install guide for running the notebook