API Configuration

This guide will show Data Scientists how to configure their notebooks or IDE to use Vectice.

Your API Token

Generate a personal access token for quick access to the Vectice API and integrate your data science workflows with Vectice.

To access or create API Tokens, click on your profile icon in the upper right corner of the Web UI and select API Tokens. Select Create API Token, then either copy and store your token in a safe location or download it as a JSON file. You will only be able to perform these actions once for security reasons.

Configuring your development environment

To connect to the Vectice API, you must configure your development environment by adding your credentials. You will need the following:

Credentials	Tips
Your API Token	To create a new API Token, follow the instructions found here.
Vectice API Endpoint	This is usually the same endpoint used to access your web UI page ( i.e., https://app.vectice.com)
Workspace Name
Project Name

Connect to Vectice API

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

Example #1

import vectice

project = vectice.connect(
        api_token="YOUR_API_TOKEN",
        host="VECTICE_API_ENDPOINT",
        workspace="YOUR_WORKSPACE_NAME",
        project="YOUR_PROJECT_NAME",
    )

Example #2

import vectice

project = vectice.connect(
        config="<API_key_config_name>.json",
        workspace="YOUR_WORKSPACE_NAME",
        project="YOUR_PROJECT_NAME",
    )