Create an embedding endpoint through the root-level API

Save an access endpoint for an embedding model backend.

POST 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. For private deployments, use the corresponding product API URL.

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

Request

curl --request POST \
  "$BASE_URL/embedding/backends/$BACKEND_ID/endpoints" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID" \
  --header "Content-Type: application/json" \
  --data-raw '{"address":"https://provider.example.invalid/v1"}'

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 an earlier read.

address

Body

string

Yes

Nonempty access URL after trimming surrounding whitespace.

Requires backend update permission. Save the returned endpoint id; its initial state is online. Marking it online does not verify service health or model capability. There is no separate endpoint deletion operation; adjust its state as needed.

Successful response

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 21,
    "backend_id": 12,
    "address": "https://provider.example.invalid/v1",
    "status": "ONLINE",
    "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 using the corresponding read operation.

Last updated on