Introduction
MCP Tools
REST API
Typescript REST SDK
PythonSDK Client
curl --request POST \
--url http://localhost:8080/api/v2/config/resources/embedders \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"provider": "openai",
"config": {}
}
'{
"success": true,
"status": "ready",
"error": "<string>"
}Add Embedder Endpoint
Add a new embedder configuration at runtime.
Creates a new embedder with the specified configuration and attempts to initialize it immediately. This allows adding embedders 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: OpenAI embedding models (requires api_key, model)amazon-bedrock: AWS Bedrock embedding models (requires region, model_id)sentence-transformer: Local sentence transformer models (requires model)
The response indicates whether the embedder was successfully initialized:
success: true, status: ready: Embedder is available for usesuccess: false, status: failed: Initialization failed (check error field)
If initialization fails, the embedder 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.
curl --request POST \
--url http://localhost:8080/api/v2/config/resources/embedders \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"provider": "openai",
"config": {}
}
'{
"success": true,
"status": "ready",
"error": "<string>"
}Body
Specification for adding a new embedder.
Unique name/identifier for the embedder.The embedder provider type (e.g., 'openai', 'amazon-bedrock', 'sentence-transformer').openai, amazon-bedrock, sentence-transformer Provider-specific configuration settings.Response
Successful Response