Skip to main content
GET
/
knowledge_bases
/
embedding_models
List embedding models compatible with the KB dimension policy
curl --request GET \
  --url https://api.example.com/knowledge_bases/embedding_models \
  --header 'x-user-id: <x-user-id>'
{
  "providers": [
    {
      "credential": {
        "data": {},
        "id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "user_id": "<string>"
      },
      "models": [
        {
          "name": "<string>",
          "label": "<string>",
          "dimensions": 123,
          "type": "embedding_model",
          "status": "active",
          "input_types": [
            "text/plain"
          ],
          "output_types": [
            "application/x-embedding"
          ],
          "supported_dimensions": [
            123
          ],
          "context_size": 1,
          "parameter_schema": {},
          "parameter_overrides": {}
        }
      ]
    }
  ],
  "policy": {
    "dimension": 123
  }
}

Headers

x-user-id
string
required

Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.

Response

Successful Response

Response body listing KB-compatible embedding models.

The list is pre-filtered server-side against the manager's dimension policy. The policy itself is also returned so the front-end can render an explanatory banner and lock the dimension selector when applicable.

providers
KbEmbeddingProvider · object[]
required

One entry per credential that has at least one compatible embedding model.

policy
DimensionPolicy · object
required

The dimension policy used to filter the cards; surfaced verbatim so the UI can explain why models were filtered.