Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vectorshift.ai/llms.txt

Use this file to discover all available pages before exploring further.

The SDK authenticates with a VectorShift API key. Generate one in the platform under Account → API Keys.

​
Set the API key

The SDK reads VECTORSHIFT_API_KEY at import time. Set it once in your shell or secrets manager:
export VECTORSHIFT_API_KEY="vs-..."

import vectorshift

print(vectorshift.api_key[:4] + "..." if vectorshift.api_key else "missing")

​
Per-organization keys

If you belong to multiple organizations, generate the key from inside the org you want the SDK to act on. The key carries the org context — there’s no separate org_id parameter.

​
Rotating keys

1

Generate

Create a new key in the platform.
2

Update

Roll out the new key to your environment / secret store.
3

Revoke

Delete the old key in the platform once nothing depends on it.
Old keys keep working until you delete them, so there’s no hard cutover.

​
Errors

​
AuthenticationError
exception
Raised when the key is missing or invalid.
​
PermissionDeniedError
exception
Raised when the key is valid but lacks scope for the requested operation.
from vectorshift import AuthenticationError, PermissionDeniedError, Pipeline

try:
    Pipeline.list()
except AuthenticationError:
    ...  # missing or invalid key
except PermissionDeniedError:
    ...  # key valid but not authorized

​
What’s next

Quick start

Install and verify the SDK.

Pipeline overview

Your first pipeline in five lines.