Quick Start

npm install -g @coreviz/cli

curl -X POST https://api.coreviz.io/api/upload

Introduction

CoreViz is a visual AI assistant platform that allows you to index and bulk process large image and video datasets. Whether you're working with thousands of images or hours of video footage, CoreViz helps you organize, search, and analyze your visual data efficiently.

Key Features

Getting Started

Option 1: Web Interface (Recommended for beginners)

1. Visit lab.coreviz.io
2. Sign up for a free account
3. Create your first organization
4. Start uploading images and videos

Option 2: API Integration

Install the CoreViz CLI for programmatic access:

npm install -g @coreviz/cli

pnpm add -g @coreviz/cli

yarn global add @coreviz/cli

Authenticate with your API key:

npx @coreviz/cli login

Option 3: Direct API Access

Use the REST API directly with your preferred programming language:

curl -X POST https://api.coreviz.io/api/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@image.jpg" \
  -F "entityId=your_entity_id"

Your First Upload

Using the Web Interface

1. Create an Organization: Set up your workspace
2. Create a Dataset: Organize your content by project or category
3. Create an Entity: Define what you're uploading (e.g., "Product Photos", "Security Footage")
4. Upload Media: Drag and drop or select files to upload
5. Wait for Processing: CoreViz automatically indexes your content
6. Start Searching: Use natural language to find what you need

Using the CLI

# Create an organization
npx @coreviz/cli org create "My Organization"

# Create a dataset
npx @coreviz/cli dataset create "Product Catalog" --org "My Organization"

# Create an entity
npx @coreviz/cli entity create "Electronics" --dataset "Product Catalog"

# Upload files
npx @coreviz/cli upload "path/to/images/*.jpg" --entity "Electronics"

Search Your Content

Once your content is indexed, you can search in multiple ways:

Text Search

"red car in parking lot"
"person wearing blue shirt"
"product with logo"

Object-Based Search

"find all images with cars"
"videos containing people"
"images with text or signs"

Similarity Search

Find visually similar images by uploading a reference image or selecting from your existing content.

FAQ

Some common questions you may encounter.

Learn More

Ready to dive deeper? Explore these resources to get the most out of CoreViz.

Core Features

Advanced Topics