Skip to main content

Vectros SDK for Python

pypi license

The official Python client for the Vectros API — hybrid search, document ingestion, structured records, and grounded inference for your application.

Installation

pip install vectros

Requires Python 3.8+.

Quick start

import os
from vectros import VectrosApi

client = VectrosApi(
    base_url="https://api.vectros.ai",
    token=os.environ["VECTROS_API_KEY"],  # sk_live_... or sk_test_...
)

# Hybrid (keyword + semantic) search over your indexed content
results = client.search.content(
    query="patient intake form diabetes",
)

# Ingest a document — extracted, chunked, and indexed for search + RAG
doc = client.documents.ingest_document(
    title="Patient Intake Form — Jane Doe",
)

# Write a structured record against one of your schemas
record = client.records.create_record(
    type_name="intake_form",
    schema_id="6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    payload={"first_name": "Jane", "email": "jane@example.com"},
)

An AsyncVectrosApi with the same surface is available for asyncio.

Authentication

The SDK sends whatever credential you pass in the Authorization: Bearer <token> header. Two credential types are accepted:

Type Prefix Lifetime Use from
API key sk_live_* / sk_test_* Long-lived Server only — full tenant access
Scoped token st_* Short-lived Server or browser — narrowed scope, auto-expiring

Keep API keys server-side only. For untrusted runtimes, mint a short-lived scoped token on your backend and pass it as token. See the authentication guide for the full pattern.

What you can do

  • Hybrid search & RAGclient.search, client.inference — vector + keyword search and grounded document Q&A over your indexed corpus.
  • Documents & foldersclient.documents, client.folders — ingest, organize, retrieve, and look documents up by field.
  • Structured recordsclient.records — create, read, update (full and partial), delete, and look records up by indexed field.
  • Schemasclient.schemas — define and evolve record/document schemas.
  • Identity & accessclient.identity, client.auth — manage users and namespaced identity entities (org and client are built in, alongside any namespace you register); mint and revoke scoped credentials.

Full API reference

Every method, parameter, and type is documented in reference.md.

Rate limits

Requests are rate limited per account on a fixed one-minute window — writes, searches, and inference count against it; reads do not. When you exceed the limit the API returns HTTP 429 with a Retry-After header (seconds until the window resets) plus X-RateLimit-Limit and X-RateLimit-Remaining. Honor Retry-After (or back off exponentially with jitter), and pace bulk work so your steady rate stays under your plan's per-minute budget. See the rate limits guide for the per-plan limits.

Documentation

Security & trust

Vectros enforces per-customer, fail-closed isolation and least-privilege scoped keys, with a tamper-evident audit and version history. Customer-facing surfaces are hardened through extensive adversarial security review. For the full trust posture, drawn plainly with its boundaries, see the compliance and trust guide.

License

Apache License 2.0.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vectros-0.38.0.tar.gz (288.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vectros-0.38.0-py3-none-any.whl (421.7 kB view details)

Uploaded Python 3

File details

Details for the file vectros-0.38.0.tar.gz.

File metadata

  • Download URL: vectros-0.38.0.tar.gz
  • Upload date:
  • Size: 288.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.15

File hashes

Hashes for vectros-0.38.0.tar.gz
Algorithm Hash digest
SHA256 e4eb02f51b4008609beafe1ec825da98a8e8f30b36f5117642d8332b23bd80bd
MD5 9044b41edb07f3b17b6fc5b751aa8475
BLAKE2b-256 d9000feb513ae386cc1bae8263341345c6aee1867aa5ad2b4485b7fe4d6bb318

See more details on using hashes here.

File details

Details for the file vectros-0.38.0-py3-none-any.whl.

File metadata

  • Download URL: vectros-0.38.0-py3-none-any.whl
  • Upload date:
  • Size: 421.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.15

File hashes

Hashes for vectros-0.38.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7ab128ff3ff637c0b1d6a1e45368cab078eae99afe24f7dc56c951b8e3c92516
MD5 7057b0633dbfe84bd08022540034d39e
BLAKE2b-256 a364e9363da79ec4d6d3957d3ba23b0151e0f862b0127c619d4d58ca106bb7db

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page