Get an LLM backend through the Workspace API

Read configuration for an LLM backend.

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

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 GET \
  "$BASE_URL/workspaces/$WORKSPACE_ID/llm/backends/$BACKEND_ID" \
  --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.

workspace_id

Path

string

Yes

Workspace ID in the same environment.

backend_id

Path

integer

Yes

Positive ID returned by an earlier read.

Workspace-level details remove api_key_encrypted, may omit zero/empty fields, and do not include endpoints. Uses model_backend.read; does not establish update or model runtime privileges.

Successful response

{
  "code": 0,
  "data": {
    "id": 12,
    "name": "临时后端",
    "timeout_seconds": 120,
    "models": [
      "chat-example"
    ],
    "created_at": 1794445200,
    "updated_at": 1794445200,
    "provider_origin": "external_provider"
  }
}

HTTP 200。

Field

Type

Description

code

integer

0 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