Connect to the Vectice API

Learn how to connect to the Vectice API from your working environment and the prerequisites needed to begin registering assets to Vectice.

To use the sample notebooks, please ensure you replace "my_api_token" at the top of the notebook with your API token. If you have lost your API Token, open the JSON file you downloaded on the previous page to retrieve the key or simply create a new token by following the instruction on the "Create an API Token" page in the left menu under GETTING STARTED.

The examples below show you the two ways to use your credentials to connect directly to Vectice.

Example #1

import vectice

project = vectice.connect(config="vectice_config.json")

Example #2

import vectice

project = vectice.connect(api_token="YOUR_API_TOKEN")

Once you have run the code, you will see a welcome message that states your connection to Vectice was successful. 🎉

Prerequisites for registering assets

You must complete the following prerequisites before registering your datasets and models to Vectice.

• Ensure you have installed the Vectice Python client library in your working environment.

• Retrieve and save your API Key to use when connecting to the Vectice API.

• Have at least one step defined in the Vectice UI before beginning an iteration to register your assets. Learn more by viewing our Iterative Development guide to get started.