Skip to content

Models

GET /v1/models lists the models you may use, in OpenAI's format with a few more fields.

curl -s https://ai.example.internal/v1/models -H "Authorization: Bearer $FADEN_API_KEY"
{
  "object": "list",
  "data": [
    {
      "id": "team-assistant",
      "object": "model",
      "owned_by": "fadenstack",
      "alias": "team-assistant",
      "description": "General chat for everyone",
      "enabled": true,
      "kind": "chat"
    }
  ]
}
Field Means
id, alias The name to send as model. Your administrator chooses it; the same name can move to another model or machine without your code changing.
description What the model is for, as your administrator wrote it
kind chat, embeddings, scoring, or null if not set
enabled Whether it takes requests now

Where a model runs, on the organisation's machines or at an outside provider, is the administrator's choice and can change; your code only uses the name.