Create a parser endpoint

Save an access endpoint for a parser backend.

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

Request

curl --request POST \
  "$BASE_URL/parser/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://parser.example.invalid"}'

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.

address

Body

string

Yes

Nonempty URL after trimming surrounding whitespace.

Requires backend update permission. Returns a new endpoint ID, initially ONLINE. Saving and marking online do not verify service health or parsing results.

Save response data.id as ENDPOINT_ID for Setting status. Retain this ID before taking the endpoint offline.

Successful response

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 21,
    "backend_id": 12,
    "address": "https://parser.example.invalid",
    "status": "ONLINE",
    "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