Get Custom Components

get https://api.cloud.deepset.ai/api/v2/custom_components

Get a list of custom components currently uploaded to deepset Cloud.
The list includes all the details of each component, such as its status and version.

Query Params

limit

integer

≤ 100

Defaults to 10

How many entries do you want to display? Leaving this field empty keeps the default setting and max 10 results are returned.

before

Enter an ID if you want to see all entries before this ID.

after

Enter an ID if you want to see all entries after this ID.

page_number

Defaults to 1

Which page do you want to see? Type the number.

field

string

Defaults to created_at

The name of the entity you want to sort by.

order

string

Defaults to DESC

Choose how you want to sort the results.

select

Partial implementation of the OData $select operator. It currently only supports selecting fields from the root entity or a child entity. Selecting fields from children's children is not supported. If you use this parameter, the API response is always a flat list of distinct JSON objects with the selected properties, for example, '[{"given_name": "user1", "user_id": "..."}, ...]' for 'select=created_by/given_name, created_by/user_id'. The results are ordered by the first selected attribute. To learn more about the OData filter syntax, see: Querying Data.

filter

The OData filter you want to use in your query. It supports exact match and AND operations. For example, to filter for a metadata category:news, here's what the URL could look like: 'url = "https://api.cloud.deepset.ai/api/v1/workspaces/production/files?limit=10&filter=category eq 'news'"'. OData filters only work with cursor-based pagination (leave the page_number field blank to enable it).To learn more about the OData filter syntax, see: Querying Data.

Responses

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.cloud.deepset.ai/api/v2/custom_components?limit=10&page_number=1&field=created_at&order=DESC' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error