You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-foundry/foundry-local/reference/reference-catalog-api.md
+85-11Lines changed: 85 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,26 +15,100 @@ author: maanavd
15
15
16
16
This document provides a detailed reference for catalog implementers that want to create their own catalog implementations to be integrated with Foundry Local.
17
17
18
-
## Catalog Host
18
+
The catalog API is a RESTful API that allows you to query and manage your model catalog. The API supports the following operations:
19
19
20
-
### URI format
20
+
-**Search**: Search for models in the catalog based on various criteria.
21
+
-**List**: List all models in the catalog.
21
22
22
-
The catalog host URI is the base URL for your catalog API. It should be in the following format:
23
+
## Request
23
24
24
-
```
25
-
https://<catalog provider URI>/<provider subpath>
26
-
```
25
+
THe catalog API is a POST endpoint that accepts a JSON request body. The request must be anonymous and does not require authentication.
26
+
27
+
The request format for the catalog API is as follows:
28
+
29
+
-**Method**: `POST`
30
+
-**Content-Type**: `application/json`
31
+
-**User-Agent**: `AzureAiStudio`
27
32
28
-
### Authorization
33
+
The request body must be a JSON object that contains the following fields:
29
34
30
-
All endpoints must support:
35
+
-`resourceIds`: An array of resource IDs that specify the resources to be queried.
36
+
-`indexEntitiesRequest`: An object that contains the search parameters.
37
+
-`filters`: An array of filter objects that specify the criteria for filtering the search results.
38
+
-`pageSize`: The maximum number of results to return (for pagination).
39
+
-`skip`: The number of results to skip (for pagination).
40
+
-`continuationToken`: A token for pagination to continue from a previous request.
0 commit comments