VecDB API
  • 🌱VecDB
  • 🌱Structure
  • 🌱Glossary
  • 🌱FAQ
  • πŸ’»API Reference
  • Get Started
    • πŸ’»Authentication
    • πŸ’»Build Your First Search
      • πŸ’»Creating your first dataset
      • πŸ’»Encoding + Inserting
      • πŸ’»Your First Text To Image Search!
  • for your understanding
    • 🌱Concepts about vectors
    • 🌱What is vector search?
    • 🌱Vectors for classification
    • 🌱Limitations of vectors
  • Guides
    • πŸ’»Combine keyword search with vector search
  • ADMIN
    • 🌱Project Overview
      • πŸ’»Project Creation
      • πŸ’»List All Datasets
      • Best Practice With Project Management
      • πŸ’»Copy dataset
      • πŸ’»Copy dataset from another project
      • πŸ’»Request an API key
      • πŸ’»Request a read-only API key
  • Services
    • πŸ”Search
      • Text Search
      • Vector Search
      • Hybrid Search
      • Traditional Search
    • πŸ”Predict
      • πŸ’»KNN regression from search results
      • πŸ’»KNN Regression
    • πŸ”Tag
      • πŸ’»Tagging
      • πŸ’»Diversity Tagging
    • πŸ”Cluster
      • Cluster A Dataset Field
  • DATASETS
    • 🌱Datasets Overview
      • 🌱Special Field Types
  • WORKFLOWS
    • 🌱Workflow Overview
Powered by GitBook
On this page

Was this helpful?

  1. Get Started

Authentication

How to authorise through the API

PreviousAPI ReferenceNextBuild Your First Search

Last updated 3 years ago

Was this helpful?

VecDB uses API keys to allow access to the API. You can sign up for an api key ator you can find your API keys on your Qualitative Cloud dashboard, which you can access by logging in or signing up at .

To authorize, provide your project name and API key to the Authorization header in the format of {project}:{api_key}:

import requests
response = requests.post(
    url=url,
    header={"Authorization": "project:api_key"},
    json={
        ...
    })
response.json()

Be sure to keep your API key somewhere safe either in some sort of secure note storage.

πŸ’»
https://vecdb.com
https://relevance.ai