Create Catalog

Artifact in Instill Core is an API service for transforming and accessing unstructured data. It processes files—such as documents, images, audio, and video—into a unified, AI-ready format called a Catalog. This catalog stores structured, chunked, and embedded content, enabling seamless integration with Pipeline and Model for Retrieval-Augmented Generation (RAG) and other AI workflows.

Artifact offers multiple methods for creating a catalog, including HTTP and gRPC APIs, the Python and TypeScript SDKs, and Console.

Create Catalog via API

curl -X POST 'http://localhost:8080/v1alpha/namespaces/{NAMESPACE_ID}/catalogs' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer {INSTILL_API_TOKEN}" \
--data '{ 
"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 with the Catalog owner's ID (namespace). The new name should be lowercase, without any spaces or special characters 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.