Get an embedding backend (workspace endpoint)

Read configuration for the specified embedding model backend.

GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/embeddings/backends/{backend_id}

Before you call this API

BASE_URL uses the product API prefix https://api.moi.matrixorigin.cn/v5. For a dedicated deployment, use its corresponding product API address.

Configure identity, Workspace, and object permissions in the same environment.

Request

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

Parameter

Location

Type

Required

Description

X-Workspace-ID

Header

string

Yes

Workspace ID in the same environment.

workspace_id

Path

string

Yes

Workspace ID in the same environment.

backend_id

Path

integer

Yes

Positive ID returned by an earlier read.

Workspace-scoped details remove api_key_encrypted and may omit zero/empty fields; endpoints are excluded. Uses model_backend.read, which does not imply modification or model runtime privileges.

Successful response

{
  "code": 0,
  "data": {
    "id": 12,
    "name": "临时后端",
    "timeout_seconds": 30,
    "models": [
      "bge-m3"
    ],
    "created_at": 1794445200,
    "updated_at": 1794445200,
    "provider_origin": "unknown"
  }
}

HTTP 200。

Field

Type

Description

code

integer

0 on success.

data

object

Actual objects for this protocol.

Error response

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

Last updated on