This quickstart guide will walk you through creating a simple multimodal search application with Mixpeek. You’ll learn how to ingest content, extract features, and build a search endpoint.
Prerequisites
Before you begin, make sure you have:- A Mixpeek account (sign up at mixpeek.com/start)
- Your API key (found in your dashboard)
- Basic familiarity with REST APIs
Base URL and Headers
All requests use the base URLhttps://api.mixpeek.com
and require an API key. Most endpoints also require a namespace header.
1) Create a Namespace
Namespaces isolate data and queries. You can also use an existing namespace if you have one.namespace_id
and use it in X-Namespace
for subsequent calls.
2) Create a Bucket
bucket_id
from the response.
3) Create a Collection
Collections define processing lineage and (optionally) feature extractors.collection_id
.
4) Upload an Object
Creating an object registers the files but does not start processing. Processing requires creating and submitting a batch.object_id
from the response.
5) Create a Batch
batch_id
from the response.
6) Submit the Batch for Processing
task_id
you can poll.
7) Check Task Status
status
to become COMPLETED
.