Catalog Management | Documentation

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 'HOST_URL/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 'HOST_URL/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 'HOST_URL/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.

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.

#Manage Catalogs via Console

#List Catalogs

To list the Catalogs under a namespace in 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.

Your Catalogs will automatically appear below.

#Update Catalog

To update a Catalog's description in 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 ... in the bottom-right of the Catalog card you wish to update.
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 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 ... in the bottom-right of the Catalog card you wish to delete.
Select Delete.