---
title: "List the local PhEye models."
method: GET
path: "/api/models"
tags: ["Models"]
---

# List the local PhEye models.

`GET /api/models`

## Request

- Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/models`
- Auth: HTTP bearer

Returns the models in the deployment's models directory (PHEYE_MODELS_DIRECTORY), ordered by name. A ph-eye filter uses one by giving its name as phEyeConfiguration.modelPath; the model then runs inside Philter. The directory is read on each request, so a model an administrator adds is listed without a restart. The models are the deployment's, the same for every user. Requires the `policies:read` scope.

## Headers

- `Authorization` string, required

## Response `200`

Every model, which may be none.

- GetModelsResponse
  - `models` ModelResponse[]: Every model, ordered by name. Empty when the deployment has none.
    - `name` string: The model's name, which a policy gives as a ph-eye filter's phEyeConfiguration.modelPath.
    - `encoder` string, nullable: The encoder the model was trained from, from its gliner_config.json, for example microsoft/deberta-v3-small. Absent when the configuration does not say.
    - `maxLength` integer, nullable: The most words of a text the model reads; later words are not examined. Absent when the configuration does not say.
    - `maxWidth` integer, nullable: The most words one detected entity can span. Absent when the configuration does not say.
    - `sizeBytes` integer: The combined size, in bytes, of its gliner_config.json, tokenizer.json, and model.onnx.

## Other responses

- `400`: Bad Request
- `401`: The Authorization header is absent or the API key is not recognized.
- `403`: Insufficient scope, disabled API, or access denied.
- `404`: Not Found
- `406`: No representation matches Accept.
- `413`: Content Too Large
- `415`: Unsupported Media Type
- `500`: Internal Server Error
- `503`: Service Unavailable

## Changes

- **2026-10-18** `d8595725f6dd`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/philterd/apis/philter-api/changes/api/models/get.md)

---

[API](https://skmtc.dev/philterd/apis/philter-api.md) - [All operations](https://skmtc.dev/philterd/apis/philter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/philterd/apis/philter-api/revisions/aa3d7ad1aab4?raw)