API docs by Redocly

BKN 知识网络 · 代理账户 API (0.2.0)

Download OpenAPI specification:

OAuth-protected governance APIs and cluster-internal runtime APIs for environment-local knowledge-network proxy mappings.

The model version covers data and execution bindings only. A Skill mounted on the network contributes a skill/execute grant source that resolve accepts and synchronization materializes, but it is excluded from the version and is best effort: when the delegator lacks execute on the Skill, or bkn-safe rejects Skill sources, synchronization leaves that grant out, logs it, and the mapping still becomes ready. Mounting a new Skill still requires the mounter to hold execute on it, as for a tool.

List knowledge-network proxy mappings in the caller's governance scope

Returns only mappings for knowledge networks on which the OAuth caller has the authorize operation. Unauthorized mapping existence and proxy account identifiers are not disclosed.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0
}

Get one governed knowledge-network proxy mapping

Authorizations:
OAuth2
path Parameters
kn_id
required
string <= 128 characters

Responses

Response samples

Content type
application/json
{
  • "kn_id": "string",
  • "proxy_account_id": "string",
  • "proxy_account_type": "app",
  • "lifecycle_status": "active",
  • "last_error_code": "PROXY_SYNC_FAILED",
  • "version": 0,
  • "sync_status": "pending",
  • "published_model_version": "string",
  • "synced_model_version": "string",
  • "created_at": 0,
  • "updated_at": 0
}

Preview the published binding sources used for proxy synchronization

Authorizations:
OAuth2
path Parameters
kn_id
required
string <= 128 characters

Responses

Response samples

Content type
application/json
{
  • "kn_id": "string",
  • "proxy_account_id": "string",
  • "model_version": "string",
  • "sources": [
    ]
}

Retry proxy synchronization from the latest persisted main model

Authorizations:
OAuth2
path Parameters
kn_id
required
string <= 128 characters

Responses

Response samples

Content type
application/json
{
  • "kn_id": "string",
  • "proxy_account_id": "string",
  • "proxy_account_type": "app",
  • "lifecycle_status": "active",
  • "last_error_code": "PROXY_SYNC_FAILED",
  • "version": 0,
  • "sync_status": "pending",
  • "published_model_version": "string",
  • "synced_model_version": "string",
  • "created_at": 0,
  • "updated_at": 0
}

Detect and reconcile proxy authorization drift

The caller must hold authorize on every live main-branch knowledge network, including those without a proxy mapping. Authorization completes before any policy repair starts.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "missing_mappings": [
    ],
  • "orphan_mappings": [
    ],
  • "conflicting_proxy_accounts": {
    },
  • "authorization_drift": {
    },
  • "failed_kn_ids": [
    ]
}

Resolve the managed runtime proxy and publication synchronization state

The trusted runtime authorizes the original business caller before using this lookup. The lookup itself does not require proxy-administration permission.

path Parameters
kn_id
required
string <= 128 characters

Responses

Response samples

Content type
application/json
{
  • "kn_id": "string",
  • "proxy_account_id": "string",
  • "proxy_account_type": "app",
  • "lifecycle_status": "active",
  • "version": 0,
  • "sync_status": "pending",
  • "published_model_version": "string",
  • "synced_model_version": "string",
  • "resolved_binding": {
    },
  • "last_error": "string",
  • "created_at": 0,
  • "updated_at": 0
}

Resolve a runtime proxy only for an exact published grant snapshot binding

Cluster-internal endpoint for ontology-query after caller authorization. BKN reads the synchronized grant snapshot and returns the managed proxy together with the resolved binding. For action and logic-property lookups, target_type is omitted and is returned from the snapshot.

path Parameters
kn_id
required
string <= 128 characters
Request Body schema: application/json
required
child_type
required
string
Enum: "object_type" "relation_type" "metric" "action_type" "logic_property"
child_id
required
string
target_type
string
Enum: "resource" "tool_box" "function" "mcp"
target_id
required
string
operation
required
string
Enum: "view_detail" "query_data" "execute"

Responses

Request samples

Content type
application/json
{
  • "child_type": "object_type",
  • "child_id": "string",
  • "target_type": "resource",
  • "target_id": "string",
  • "operation": "view_detail"
}

Response samples

Content type
application/json
{
  • "kn_id": "string",
  • "proxy_account_id": "string",
  • "proxy_account_type": "app",
  • "lifecycle_status": "active",
  • "version": 0,
  • "sync_status": "pending",
  • "published_model_version": "string",
  • "synced_model_version": "string",
  • "resolved_binding": {
    },
  • "last_error": "string",
  • "created_at": 0,
  • "updated_at": 0
}

Retry synchronization from the latest persisted main model

path Parameters
kn_id
required
string <= 128 characters

Responses

Response samples

Content type
application/json
{
  • "kn_id": "string",
  • "proxy_account_id": "string",
  • "proxy_account_type": "app",
  • "lifecycle_status": "active",
  • "version": 0,
  • "sync_status": "pending",
  • "published_model_version": "string",
  • "synced_model_version": "string",
  • "resolved_binding": {
    },
  • "last_error": "string",
  • "created_at": 0,
  • "updated_at": 0
}

Dry-run the source set derived from the latest persisted main model

path Parameters
kn_id
required
string <= 128 characters

Responses

Response samples

Content type
application/json
{
  • "kn_id": "string",
  • "proxy_account_id": "string",
  • "model_version": "string",
  • "sources": [
    ]
}

Resume proxy archival and KN policy cleanup after business data deletion committed

path Parameters
kn_id
required
string <= 128 characters

Responses

Detect mapping defects and reconcile bkn-safe authorization ledger drift

The caller must hold authorize on every live main-branch knowledge network, including those without a proxy mapping. Authorization is completed before any policy repair starts; orphan mappings are reported without mutation.

Responses

Response samples

Content type
application/json
{
  • "missing_mappings": [
    ],
  • "orphan_mappings": [
    ],
  • "conflicting_proxy_accounts": {
    },
  • "authorization_drift": {
    },
  • "errors": {
    }
}