List embedding backends through the root API

List embedding model backends readable in the current workspace.

GET https://api.moi.matrixorigin.cn/v5/embedding/backends

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 object permissions in the same environment.

Request

curl --request GET \
  "$BASE_URL/embedding/backends" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID"

Parameter

Location

Type

Required

Description

X-Workspace-ID

Headers

string

Yes

Workspace ID in the same environment.

No pagination or total. Returns data.backends; an empty result may be null. Lists filter by model_backend.read and are not the complete routing pool of system-default/deployed models.

Successful response

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "backends": [
      {
        "id": 12,
        "name": "临时后端",
        "type": "OPENAI",
        "timeout_seconds": 30,
        "models": [
          "bge-m3"
        ],
        "created_at": 1794445200,
        "updated_at": 1794445200,
        "reasoning_control_protocol": "REASONING_CONTROL_NONE",
        "endpoints": [
          {
            "id": 21,
            "backend_id": 12,
            "address": "https://provider.example.invalid/v1",
            "status": "ONLINE",
            "created_at": 1794445200,
            "updated_at": 1794445200
          },
          {
            "id": 22,
            "backend_id": 12,
            "address": "https://provider.example.invalid/v1",
            "status": "OFFLINE",
            "created_at": 1794445200,
            "updated_at": 1794445200
          }
        ]
      }
    ]
  }
}

HTTP 200。

Field

Type

Description

code

string

OK on success.

msg

string

OK on success.

data

object

Actual objects for this protocol.

Error responses

Errors and result confirmation distinguishes the two protocols. Parse omitted fields, SDK zero values, and empty HTTP responses separately. Confirm writes with the corresponding reads.

Last updated on