Create Catalog | Documentation

This page shows you how to create a new, empty Catalog.

This is the first step that is required before you are able to upload and process your files with Artifact into a unified AI-ready format.

#Create Catalog via API

cURL

Python

export INSTILL_API_TOKEN=********
curl -X POST 'HOST_URL/v1alpha/namespaces/NAMESPACE_ID/catalogs' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $INSTILL_API_TOKEN" \
--data '{
  "name": "Your Catalog Name",
  "description": "A brief description of your Catalog"
}'

Note that the NAMESPACE_ID path parameter must be replaced by the Catalog owner's ID (namespace). The new name should be lowercase, without any space or special character except for hyphens. It cannot start with a number or hyphen, and should be less than 32 characters.

INFO

If you are using Instill Core as a managed service, set HOST_URL to https://private.instill-ai.com. If you are self-hosting Instill Core, use http://localhost:8080.

#Create Catalog via Console

To create a new Catalog from Console, follow these steps:

Launch Console via a local Instill Core deployment at http://localhost:3000, or by selecting the Go to console button in the bottom-left of the Instill Agent interface if you are using Instill Core as a managed service.
Navigate to the Artifacts page using the navigation bar.
Click the + Create Catalog button.
Select the Owner (namespace).
Enter the name for your Catalog.
(Optional) Enter the description and tags for your Catalog.
Click the Create button.