Skip to main content
List components using standard filters or semantic search.

Input Schema

Parameters

ParameterTypeDefaultDescription
projectIdstringsession defaultProject to search in
querystring-Natural language semantic search query
typestring-Filter by component type
statusstringpublishedFilter by status
collectionIdstring-Filter by collection
pagenumber1Page number
limitnumber20Items per page (max 100)

Component Types

TypeDescription
viewUI display components (cards, headers, etc.)
layoutStructural layout components (grids, stacks, etc.)
assetCatalogAsset catalog components for media management

Response

FieldTypeDescription
componentsarrayArray of component objects
components[].idstringUnique component identifier
components[].namestringDisplay name of the component
components[].descriptionstringComponent description
components[].typestringComponent type (view, layout, assetCatalog)
components[].statusstringPublication status
components[].versionnumberVersion number
components[].excerptstringRelevant text excerpt (when query is used)
components[].similaritynumberSimilarity score 0-1 (when query is used)
totalnumberTotal number of matching items

Examples

Search for components using natural language:
Response:

Filter by Type

List all published layout components:
Response:

Filter by Collection

List components in a specific collection:

Usage

Browse Components by Type

Search with Combined Filters

Combine semantic search with filters for precise results. For example, search for “hero banner” within the view type to find relevant display components.