This page shows you how to upload files to a Catalog.
During the Alpha Release period, uploading files to your Catalog is subject to the following limitations:
- Supported file types:
.md
,.txt
,.pdf
,.html
,.ppt
,.pptx
,.doc
,.docx
,.xls
,.xlsx
and.csv
- Max file size:
- Free tier:
50MB
- Pro tier:
150MB
- Free tier:
- Max file storage (per namespace):
- Free tier:
50MB
- Pro tier:
500MB
- Team tier:
2GB
- Enterprise tier:
Unlimited
- Free tier:
#Upload Files to a Catalog via API
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 updated, respectively.
The type
field in the request body specifies the file type, given as a string.
The following file types are currently supported:
FILE_TYPE_TEXT
FILE_TYPE_PDF
FILE_TYPE_MARKDOWN
FILE_TYPE_HTML
FILE_TYPE_DOCX
FILE_TYPE_DOC
FILE_TYPE_PPT
FILE_TYPE_PPTX
FILE_TYPE_XLSX
FILE_TYPE_XLS
FILE_TYPE_CSV
The content
field in the request body contains the base64-encoded content of
the file.
#Upload Files to a Catalog via 📺 Instill Console
To upload files to a Catalog from 📺 Instill Console, follow these steps:
- Launch 📺 Instill Console on ☁️ Instill Cloud or via a local 🔮 Instill Core deployment at http://localhost:3000.
- Navigate to the Artifacts page using the navigation bar.
- Click the Catalog card you wish to upload files to.
- Select
Upload Documents
in the left panel. - Drag and drop your files into the blue box or click
browse computer
to upload files.
Note:
- The upload filename must not longer than 255 characters. We recommend using a shorter filename (less than 100 characters) to avoid any issues.