VectorShift SDK
The Python SDK for building, saving, and running AI pipelines and agents on the VectorShift platform.
Prerequisites: Python 3.10+ and a VectorShift account.
Quickstart
1. Install the SDK
pip install vectorshift
2. Set your API key
Generate one at Account → API Keys, then export it:
export VECTORSHIFT_API_KEY="vs-..."
3. Build, save, and run
Paste this into a file (hello.py) and run it.
from vectorshift import Pipeline
p = Pipeline.new(name="Hello pipeline")
query = p.add(name="query").input(input_type="string")
llm = p.add(name="llm").llm(provider="openai", model="gpt-5.4", prompt=query.text)
p.add(name="answer").output(value=llm.response)
p.save()
result = p.run({"query": "What is VectorShift in one sentence?"})
print(result["outputs"]["answer"])
python hello.py
4. See it in the editor
Open the platform — your new pipeline is editable in the visual editor, identical to one built there.
For the best developer experience, enable the mypy plugin. It catches wrong field names on node builders, mismatched types between wired nodes, and agent tools missing required inputs — at edit time, before you save. Drop a mypy.ini with plugins = vectorshift.mypy_plugin and most editors (VS Code, Cursor, PyCharm, Zed) light up SDK-aware errors inline as you type.
Build with ChatGPT or Claude
Paste this at the start of a ChatGPT or Claude chat, then describe what you want. It points the model at the SDK docs so it builds the right VectorShift object — pipeline, agent, knowledge base, or table — correctly.
You are building with the VectorShift Python SDK. Before writing code, read
https://docs.vectorshift.ai/llms.txt and the SDK reference pages it links.
Follow the documented patterns exactly: use the builder API, correct node and
field names, and the right object type for my request (pipeline, agent,
knowledge base, or table). Install with `pip install vectorshift` and
authenticate via the VECTORSHIFT_API_KEY environment variable. Then build,
save, and run what I describe, returning one complete runnable script.
My request:
Documentation
Full documentation — streaming, background runs, agents, knowledge bases, and the complete API reference — lives at docs.vectorshift.ai/sdk.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vectorshift-0.1.15.tar.gz.
File metadata
- Download URL: vectorshift-0.1.15.tar.gz
- Upload date:
- Size: 2.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
547af9d35c23201464c2feab00834f17372110983f34264d5b885e749b339ee9
|
|
| MD5 |
d154a73a8f638b1ab5fd0ab0ecc07c71
|
|
| BLAKE2b-256 |
74666ca940243f8a1c42b9781a0f0e26b2a77469913c10b970805388f982a62a
|
File details
Details for the file vectorshift-0.1.15-py3-none-any.whl.
File metadata
- Download URL: vectorshift-0.1.15-py3-none-any.whl
- Upload date:
- Size: 2.9 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9cdfc765e1db5d41c4fd224944050c5054e408184e640bc27c84d230ea9c543a
|
|
| MD5 |
676a30a7d3308305db9fa9ef853bc82a
|
|
| BLAKE2b-256 |
f71eef04b3cd36371f0619120b7d1b7a67920fb56a259a1f5972aa2c5bc83c79
|
