Skip to content

Commit 98ba922

Browse files
committed
include foundry/list api
1 parent 031902f commit 98ba922

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

articles/ai-foundry/foundry-local/reference/reference-rest.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,37 @@ Compatible with the [OpenAI Embeddings API](https://platform.openai.com/docs/api
239239

240240
## Custom API
241241

242+
### GET /foundry/list
243+
244+
Retrieves a list of all available Foundry Local models in the catalog.
245+
246+
**Response:**
247+
248+
- `models` (array)
249+
List of model objects, each containing:
250+
- `name`: The unique identifier for the model.
251+
- `displayName`: A human-readable name for the model, often the same as the name.
252+
- `providerType`: The type of provider hosting the model (e.g., AzureFoundry).
253+
- `uri`: The resource URI pointing to the model's location in the registry.
254+
- `version`: The version number of the model.
255+
- `modelType`: The format or type of the model (e.g., ONNX).
256+
- `promptTemplate`:
257+
- `assistant`: The template for the assistant's response.
258+
- `prompt`: The template for the user-assistant interaction.
259+
- `publisher`: The entity or organization that published the model.
260+
- `task`: The primary task the model is designed to perform (e.g., chat-completion).
261+
- `runtime`:
262+
- `deviceType`: The type of hardware the model is designed to run on (e.g., CPU).
263+
- `executionProvider`: The execution provider used for running the model.
264+
- `fileSizeMb`: The size of the model file in megabytes.
265+
- `modelSettings`:
266+
- `parameters`: A list of configurable parameters for the model.
267+
- `alias`: An alternative name or shorthand for the model
268+
- `supportsToolCalling`: Indicates whether the model supports tool-calling functionality.
269+
- `license`: The license type under which the model is distributed.
270+
- `licenseDescription`: A detailed description or link to the license terms.
271+
- `parentModelUri`: The URI of the parent model from which this model is derived.
272+
242273
### POST /openai/register
243274

244275
Registers an external model provider for use with Foundry Local.

0 commit comments

Comments
 (0)