API Reference

List component definitions

get
https://api.instill-ai.com/v1beta/component-definitions

Returns a paginated list of component definitions, regardless their type. This offers a single source of truth, with pagination and filter capabilities, for the components that might be used in a pipeline.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

The maximum number of component definitions to return. If this parameter is unspecified, at most 10 definitions will be returned. The cap value for this parameter is 100 (i.e. any value above that will be coerced to 100).

string
enum

View allows clients to specify the desired resource view in the response.

  • VIEW_BASIC: Default view, only includes basic information (removes the spec field).
  • VIEW_FULL: Full representation.
Allowed:
string

Filter can hold an AIP-160-compliant filter expression.

  • Example: component_type="COMPONENT_TYPE_AI".
  • Example: tasks:"TASK_TEXT_GENERATION".
int32

Page number.

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