Create Catalog

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

export INSTILL_API_TOKEN=********

curl -X POST 'http://localhost:8080/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" 
}'

from instill.clients import init_artifact_client

artifact = init_artifact_client(api_token="INSTILL_API_TOKEN")
artifact.create_catalog(
    namespace_id="NAMESPACE_ID",
    name="Your Catalog Name",
    description="A brief description of your catalog",
    tags=[],
)
artifact.close()

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.

Create Catalog via Console

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

2. Navigate to the Artifacts page using the navigation bar.
3. Click the + Create Catalog button.
4. Select the Owner (namespace).
5. Enter the name for your Catalog.
6. (Optional) Enter the description and tags for your Catalog.
7. Click the Create button.