Catalog Management

Instill Artifact also provides a set of methods for catalog management, including listing, updating, and deleting catalogs.

#Manage Catalogs via API

#List Catalogs

This endpoint returns a list your Catalogs, including their metadata.

cURL
Python

export INSTILL_API_TOKEN=********
curl -X GET 'https://api.instill.tech/v1alpha/namespaces/NAMESPACE_ID/catalogs' \
--header "Authorization: Bearer $INSTILL_API_TOKEN"

#Update Catalog

This endpoint enables you to update a Catalog's description.

cURL
Python

export INSTILL_API_TOKEN=********
curl -X PUT 'https://api.instill.tech/v1alpha/namespaces/NAMESPACE_ID/catalogs/CATALOG_ID' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $INSTILL_API_TOKEN" \
--data '{
"description": "Updated description of your Catalog",
"tags": ["updated_tag1", "updated_tag2"]
}'

#Delete Catalog

This endpoint enables you to delete a Catalog.

WARNING

Please note that once a Catalog is deleted, all related uploaded and processed files will be deleted as well.

cURL
Python

export INSTILL_API_TOKEN=********
curl -X DELETE 'https://api.instill.tech/v1alpha/namespaces/NAMESPACE_ID/catalogs/CATALOG_ID' \
--header "Authorization: Bearer $INSTILL_API_TOKEN"

Note that the NAMESPACE_ID and CATALOG_ID path parameters must be replaced by the Catalog owner's ID (namespace) and the identifier of the Catalog to be deleted, respectively.

For more details, please refer to the API Reference.

#Manage Catalogs via 📺 Instill Console

#List Catalogs

To list the Catalogs under a namespace in Instill Console, follow these steps:

  1. Launch Instill Console on Instill Cloud or via a local Instill Core deployment at http://localhost:3000.
  2. Navigate to the Artifacts page using the navigation bar.

Your Catalogs will automatically appear below.

#Update Catalog

To update a Catalog's description in Instill Console, follow these steps:

  1. Launch Instill Console on Instill Cloud or via a local Instill Core deployment at http://localhost:3000.
  2. Navigate to the Artifacts page using the navigation bar.
  3. Click ... in the bottom-right of the Catalog card you wish to update.
  4. Select Edit Info.

#Delete Catalog

WARNING

Please note that once a Catalog is deleted, all related uploaded and processed files will be deleted as well.

To delete a Catalog in Instill Console, follow these steps:

  1. Launch Instill Console on Instill Cloud or via a local Instill Core deployment at http://localhost:3000.
  2. Navigate to the Artifacts page using the navigation bar.
  3. Click ... in the bottom-right of the Catalog card you wish to delete.
  4. Select Delete.