List embedding endpoints (workspace endpoint)

List currently readable endpoints for the specified embedding backend.

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

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

Requires backend read. Results sort by endpoint ID ascending and include online/offline states. data is directly an array, [] when empty.

Successful response

{
  "code": 0,
  "data": [
    {
      "id": 21,
      "backend_id": 12,
      "address": "https://provider.example.invalid/v1",
      "created_at": 1794445200,
      "updated_at": 1794445200
    },
    {
      "id": 22,
      "backend_id": 12,
      "address": "https://provider.example.invalid/v1",
      "status": 1,
      "created_at": 1794445200,
      "updated_at": 1794445200
    }
  ]
}

HTTP 200。

Field

Type

Description

code

integer

0 on success.

data

array (array of objects)

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