API Reference

List catalog files

get
https://api.instill-ai.com/v1alpha/namespaces//catalogs//files

Returns a paginated list of catalog files.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The owner/namespace uid id.

string
required

The catalog id.

Query Params
int32

The page size (default:10; max 100).

string

The next page token(default from first file's token).

filter.fileUids
array of strings

File UIDs.

filter.fileUids
string
enum

Processing status of the files.

  • FILE_PROCESS_STATUS_NOTSTARTED: NOTSTARTED
  • FILE_PROCESS_STATUS_WAITING: file is waiting for embedding process
  • FILE_PROCESS_STATUS_CONVERTING: file is converting
  • FILE_PROCESS_STATUS_CHUNKING: file is chunking
  • FILE_PROCESS_STATUS_EMBEDDING: file is embedding
  • FILE_PROCESS_STATUS_COMPLETED: completed
  • FILE_PROCESS_STATUS_FAILED: failed
  • FILE_PROCESS_STATUS_SUMMARIZING: file is summarizing
Responses

Updated 10 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago