Add Language Model Endpoint

curl --request POST \
  --url http://localhost:8080/api/v2/config/resources/language_models \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "config": {}
}
'

{
  "success": true,
  "error": "<string>"
}

Resources

Add Language Model Endpoint

Add a new language model configuration at runtime.

Creates a new language model with the specified configuration and attempts to initialize it immediately. This allows adding models without restarting the server. The configuration is persisted to the configuration file.

Security Warning: API keys and credentials are stored in plain text in the configuration file. Only use this API in protected environments. To avoid storing secrets in plain text, use environment variable references (e.g., "api_key": "$OPENAI_API_KEY") which will be resolved at runtime.

Supported providers:

openai-responses: OpenAI models using the Responses API (requires api_key, model)
openai-chat-completions: OpenAI models using Chat Completions API (requires api_key, model)
amazon-bedrock: AWS Bedrock models (requires region, model_id)

The response indicates whether the model was successfully initialized:

success: true, status: ready: Model is available for use
success: false, status: failed: Initialization failed (check error field)

If initialization fails, the model configuration is still stored and can be retried later using the retry endpoint when the underlying service becomes available.

Returns 422 if the provider type or configuration is invalid.

POST

api

config

resources

language_models

Add Language Model Endpoint

curl --request POST \
  --url http://localhost:8080/api/v2/config/resources/language_models \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "config": {}
}
'

{
  "success": true,
  "error": "<string>"
}

Body

application/json

Specification for adding a new language model.

name

string

required

Unique name/identifier for the language model.

provider

enum<string>

required

The language model provider type (e.g., 'openai-responses', 'openai-chat-completions', 'amazon-bedrock').

Available options:

openai-responses,

openai-chat-completions,

amazon-bedrock

config

Config · object

required

Provider-specific configuration settings.

Response

Successful Response

Response model for resource update operations.

success

boolean

required

Whether the operation succeeded.

status

enum<string>

required

Current status of the resource after the operation.

Available options:

ready,

failed,

pending

error

string | null

Error message if the operation failed.

Retry Embedder Endpoint

Delete Language Model Endpoint

Documentation Index

Body

Response