Skip to main content

Register an LLM

POST 

/llms

Registers a connection to a model server that exposes an OpenAI-compatible API. The endpoint must be an http or https URL with a host and without credentials. Private endpoints are accepted by default; when the API server configuration sets app.allow_private_endpoints to false, the host must resolve to public addresses only. Foundation4 does not contact the model server during registration, so an incorrect endpoint path, model name or API key appears only when the LLM is first used. The API key is optional. Foundation4 encrypts the API key before storage, and no response returns the key.

Permissions. Write on the LLM object type (llms). The key that registers the LLM receives read, write and execute permission on the new LLM.

LLMs describes the fields of a registration and the requirements on the model server.

Request​

Responses​

The LLM was registered. The body is the new LLM registration, without the API key.