Probe models on a configured embedding backend¶
Requires model_backend.read on the specified backend.
POST https://api.moi.matrixorigin.cn/v5/embedding/backends/{backend_id}/probe-models
Before you call this API¶
Set BASE_URL to the product API prefix https://api.moi.matrixorigin.cn/v5; use the corresponding product API URL for a dedicated deployment.
Configure identity, workspace, and model information in the same environment.
Request¶
curl --request POST \
"$BASE_URL/embedding/backends/$BACKEND_ID/probe-models" \
--header "X-API-Key: $MOI_KEY" \
--header "X-Workspace-ID: $WORKSPACE_ID" \
--header "Content-Type: application/json" \
--data-raw '{"api_key":"provider-key-example"}'
Parameter |
Location |
Type |
Required |
Description |
|---|---|---|---|---|
|
Headers |
string |
Yes |
Workspace ID in the same environment. |
|
Body |
string |
Yes |
Provider key for this request, nonempty after trimming whitespace. Does not automatically reuse the backend’s saved key. |
|
Path |
integer |
Yes |
Positive backend ID from the list of the same backend kind. |
Requires model_backend.read on the specified backend. Reads the first saved address, without preferring online status or automatic rotation. An empty first address fails. Candidates are not automatically written back to the backend model list; update separately afterward.
Successful response¶
{
"code": "OK",
"msg": "OK",
"data": {
"models": [
"bge-m3"
]
}
}
Field |
Type |
Description |
|---|---|---|
|
string |
OK on success. |
|
object |
Error responses¶
States and errors distinguishes string and numeric protocols. Confirm probe candidates, persistence, and actual inference separately.