Getting Started

The CoreViz API allows you to programmatically access and manage your visual content, datasets, and collections. All API requests require authentication using an API key.

Studio API

APIs for managing and accessing your uploaded media, datasets, and collections:

• Listing Your Media - Retrieve a paginated list of media items from a dataset
• Searching Your Media - Search across your organization's media using natural language queries

Vision SDK

AI-powered tools for bringing the analyzing and processing capabilties of CoreViz into your own apps

• Vision SDK Overview - Overview of all Vision SDK features
• Image Description - Generate detailed descriptions, captions, and alt text for images using AI
• Image Tagging - Automatically generate tags and classify images using AI
• Image Embeddings - Generate vector embeddings for semantic search and similarity matching
• Image Editing - Edit images with natural language prompts using AI

Authentication

All API routes require an API key that must be included in the request headers.

Getting Your API Key

1. Navigate to Your Account > API Keys
2. Generate a new API key or use an existing one
3. Copy the API key for use in your requests

Using Your API Key

Include your API key in the x-api-key header for all API requests:

curl -H "x-api-key: YOUR_API_KEY" \
  https://lab.coreviz.io/api/dataset/{dataset-id}/media

Base URL

All API endpoints are hosted at:

https://lab.coreviz.io/api

Understanding the Data Structure

CoreViz organizes your content in a hierarchical structure:

Organization
├── Dataset
│   ├── Entity (like a folder, but with attributes/metadata)
│   │   ├── Media
│   │   │   ├── Frame (1 frame for images, multiple frames for videos)
│   │   │   ├── Frame
│   │   │   └── ...
│   │   └── Media
│   │       └── Frame
│   └── Entity
│       └── Media
└── Dataset
    └── ...

Organizations

Your top-level workspace containing all datasets and configurations. Each organization has a unique identifier (organizationId) used in API requests.

Datasets

Collections of related content, typically organized by:

• Project or campaign
• Content type or category
• Time period
• Source or department

Entities

Entities are similar to folders but with additional capabilities:

• They can have attributes and metadata attached to them
• They organize media items within a dataset
• Examples: "Product Photos", "Security Footage", "Medical Images", "Marketing Assets"

Media

Individual image or video files uploaded to CoreViz. Each media item has:

• File metadata (size, format, dimensions)
• EXIF data (for images)
• Processing status
• Associated frames

Frames

Frames represent processed versions of media:

• Images: Have 1 frame (the processed image)
• Videos: Have multiple frames (extracted or processed frames from the video)
• Frames contain:
  • Processed image data
  • AI-generated captions
  • Detected objects with bounding boxes
  • Timestamps (for video frames)

Making Your First Request

Once you have your API key, you can start making requests to the API. Here's a simple example:

curl -H "x-api-key: YOUR_API_KEY" \
  "https://lab.coreviz.io/api/dataset/{datasetId}/media?limit=10"

Next Steps

• Learn how to list media in your collections
• Explore more API endpoints (coming soon)