Get a parser backend

Read nonsensitive configuration for a parser backend.

GET https://api.moi.matrixorigin.cn/v5/parser/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 permissions in the same environment.

Request

curl --request GET \
  "$BASE_URL/parser/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.

backend_id

Path

integer

Yes

Canonical positive integer ID returned by creation/read for the same Parser kind.

Requires object read permission. Responses omit keys/key pools, and endpoints project online entries only. Details cannot recover offline IDs; retain endpoint creation results.

Successful response

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 12,
    "name": "临时解析后端",
    "type": "PARSER_MINERU",
    "timeout_seconds": 3600,
    "supported_mime_types": [
      "application/pdf"
    ],
    "endpoints": [
      {
        "id": 21,
        "backend_id": 12,
        "address": "https://parser.example.invalid",
        "status": "ONLINE",
        "created_at": 1794445200,
        "updated_at": 1794445200
      }
    ],
    "created_at": 1794445200,
    "updated_at": 1794445200
  }
}

Field

Type

Description

code

string

HTTP200, OK on success.

msg

string

OK on success.

data

object

Actual objects or empty values; do not infer them from LLM envelopes.

Error responses

Errors and result confirmation distinguishes actual input, object admission, and business results.

Last updated on