List embedding endpoints through the root API

List currently readable endpoints for the specified embedding backend.

GET https://api.moi.matrixorigin.cn/v5/embedding/backends/{backend_id}/endpoints

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/$BACKEND_ID/endpoints" \
  --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.

backend_id

Path

integer

Yes

Positive ID returned by a preceding read.

Requires backend read permission. Sorts by endpoint ID ascending, retaining online and offline states. data.endpoints may be null.

Successful response

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "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