API docs by Redocly

bkn-agent (0.1.0)

Download OpenAPI specification:

BknAgent

Create Agent

Request Body schema: application/json
required
Agent Id (string) or Agent Id (null) (Agent Id)
name
required
string (Name) [ 1 .. 100 ] characters ^[0-9A-Za-z_一-鿿]+$
mode
string (Mode)
Default: "chat"
Enum: "chat" "task"
Prompt Id (string) or Prompt Id (null) (Prompt Id)
Prompt Vars Schema (object) or Prompt Vars Schema (null) (Prompt Vars Schema)
model
string (Model)
Default: ""
Array of any (Tools)
skills
Array of strings (Skills)
AgentLimits (object) or null
status
string (Status)
Default: "draft"
Enum: "draft" "published"

Responses

Request samples

Content type
application/json
{
  • "agent_id": "string",
  • "name": "string",
  • "mode": "chat",
  • "prompt_id": "string",
  • "prompt_vars_schema": { },
  • "model": "",
  • "tools": [
    ],
  • "skills": [
    ],
  • "limits": {
    },
  • "status": "draft"
}

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "name": "string",
  • "mode": "chat",
  • "prompt_id": "string",
  • "prompt_vars_schema": { },
  • "model": "",
  • "tools": [
    ],
  • "skills": [
    ],
  • "limits": {
    },
  • "status": "draft",
  • "create_user": "string",
  • "update_user": "string",
  • "create_time": 0,
  • "update_time": 0
}

List Agents

query Parameters
page
integer (Page) >= 1
Default: 1
size
integer (Size) [ 1 .. 100 ]
Default: 20

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0
}

Get Agent

path Parameters
agent_id
required
string (Agent Id)

Responses

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "name": "string",
  • "mode": "chat",
  • "prompt_id": "string",
  • "prompt_vars_schema": { },
  • "model": "",
  • "tools": [
    ],
  • "skills": [
    ],
  • "limits": {
    },
  • "status": "draft",
  • "create_user": "string",
  • "update_user": "string",
  • "create_time": 0,
  • "update_time": 0
}

Update Agent

path Parameters
agent_id
required
string (Agent Id)
Request Body schema: application/json
required
Agent Id (string) or Agent Id (null) (Agent Id)
name
required
string (Name) [ 1 .. 100 ] characters ^[0-9A-Za-z_一-鿿]+$
mode
string (Mode)
Default: "chat"
Enum: "chat" "task"
Prompt Id (string) or Prompt Id (null) (Prompt Id)
Prompt Vars Schema (object) or Prompt Vars Schema (null) (Prompt Vars Schema)
model
string (Model)
Default: ""
Array of any (Tools)
skills
Array of strings (Skills)
AgentLimits (object) or null
status
string (Status)
Default: "draft"
Enum: "draft" "published"

Responses

Request samples

Content type
application/json
{
  • "agent_id": "string",
  • "name": "string",
  • "mode": "chat",
  • "prompt_id": "string",
  • "prompt_vars_schema": { },
  • "model": "",
  • "tools": [
    ],
  • "skills": [
    ],
  • "limits": {
    },
  • "status": "draft"
}

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "name": "string",
  • "mode": "chat",
  • "prompt_id": "string",
  • "prompt_vars_schema": { },
  • "model": "",
  • "tools": [
    ],
  • "skills": [
    ],
  • "limits": {
    },
  • "status": "draft",
  • "create_user": "string",
  • "update_user": "string",
  • "create_time": 0,
  • "update_time": 0
}

Delete Agent

path Parameters
agent_id
required
string (Agent Id)

Responses

Response samples

Content type
application/json
{
  • "deleted": "string"
}

Get Task Version

Read a pinning receipt under the existing Agent-read boundary.

This performs no task creation, version publication, configuration change or Prompt-body disclosure. Project owners do not need shared-admin access merely to pin the published task configuration they are about to invoke.

path Parameters
agent_id
required
string (Agent Id)

Responses

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "agent_version": 1,
  • "prompt_version": 1,
  • "tool_free": true
}

Chat

Request Body schema: application/json
required
agent_id
required
string (Agent Id)
Thread Id (string) or Thread Id (null) (Thread Id)
message
required
string (Message) non-empty
skills
Array of strings (Skills)
Prompt Override (string) or Prompt Override (null) (Prompt Override)
object (Prompt Vars)
Response Format (object) or Response Format (null) (Response Format)

Responses

Request samples

Content type
application/json
{
  • "agent_id": "string",
  • "thread_id": "string",
  • "message": "string",
  • "skills": [
    ],
  • "prompt_override": "string",
  • "prompt_vars": { },
  • "response_format": { }
}

Response samples

Content type
null

Invoke

Run once synchronously and return only when the task reaches a terminal state.

Only a published agent may be called; a draft answers exactly like a missing one. Both chat and task modes are accepted. Execution is a single stateless turn and no thread is persisted, while the task record is still stored so the run stays observable.

path Parameters
agent_id
required
string (Agent Id)
Request Body schema: application/json
required
message
required
string (Message) non-empty
Agent Version (integer) or Agent Version (null) (Agent Version)

Run this existing agent version; omitted uses the current configuration.

skills
Array of strings (Skills)
Prompt Override (string) or Prompt Override (null) (Prompt Override)
object (Prompt Vars)
Response Format (object) or Response Format (null) (Response Format)

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "agent_version": 1,
  • "skills": [
    ],
  • "prompt_override": "string",
  • "prompt_vars": { },
  • "response_format": { }
}

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "agent_id": "string",
  • "agent_version": 0,
  • "prompt_version": 0,
  • "model": "string",
  • "model_id": "string",
  • "status": "pending",
  • "input": { },
  • "output": "string",
  • "failure_detail": "string",
  • "parent_thread_id": "string",
  • "create_time": 0,
  • "update_time": 0
}

Run

Request Body schema: application/json
required
agent_id
required
string (Agent Id)
Agent Version (integer) or Agent Version (null) (Agent Version)

Run this existing agent version; omitted uses the current configuration.

message
required
string (Message) non-empty
skills
Array of strings (Skills)
Prompt Override (string) or Prompt Override (null) (Prompt Override)
object (Prompt Vars)
Response Format (object) or Response Format (null) (Response Format)

Responses

Request samples

Content type
application/json
{
  • "agent_id": "string",
  • "agent_version": 1,
  • "message": "string",
  • "skills": [
    ],
  • "prompt_override": "string",
  • "prompt_vars": { },
  • "response_format": { }
}

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "agent_id": "string",
  • "agent_version": 0,
  • "prompt_version": 0,
  • "model": "string",
  • "model_id": "string",
  • "status": "pending",
  • "input": { },
  • "output": "string",
  • "failure_detail": "string",
  • "parent_thread_id": "string",
  • "create_time": 0,
  • "update_time": 0
}

Get Task

path Parameters
task_id
required
string (Task Id)

Responses

Response samples

Content type
application/json
{
  • "task_id": "string",
  • "agent_id": "string",
  • "agent_version": 0,
  • "prompt_version": 0,
  • "model": "string",
  • "model_id": "string",
  • "status": "pending",
  • "input": { },
  • "output": "string",
  • "failure_detail": "string",
  • "parent_thread_id": "string",
  • "create_time": 0,
  • "update_time": 0
}

Create Prompt

Request Body schema: application/json
required
Prompt Id (string) or Prompt Id (null) (Prompt Id)
name
required
string (Name) [ 1 .. 100 ] characters
content
required
string (Content) non-empty
Vars Schema (object) or Vars Schema (null) (Vars Schema)

Responses

Request samples

Content type
application/json
{
  • "prompt_id": "string",
  • "name": "string",
  • "content": "string",
  • "vars_schema": { }
}

Response samples

Content type
application/json
{
  • "prompt_id": "string",
  • "name": "string",
  • "current_version": 0,
  • "content": "string",
  • "vars_schema": { },
  • "update_user": "string",
  • "update_time": 0
}

List Prompts

query Parameters
page
integer (Page) >= 1
Default: 1
size
integer (Size) [ 1 .. 100 ]
Default: 20

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0
}

Get Prompt

path Parameters
prompt_id
required
string (Prompt Id)

Responses

Response samples

Content type
application/json
{
  • "prompt_id": "string",
  • "name": "string",
  • "current_version": 0,
  • "content": "string",
  • "vars_schema": { },
  • "update_user": "string",
  • "update_time": 0
}

Publish Version

Publish a new version: write t_agent_prompt_version, advance current_version, take effect globally at once.

path Parameters
prompt_id
required
string (Prompt Id)
Request Body schema: application/json
required
content
required
string (Content) non-empty
Vars Schema (object) or Vars Schema (null) (Vars Schema)

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "vars_schema": { }
}

Response samples

Content type
application/json
{
  • "prompt_id": "string",
  • "name": "string",
  • "current_version": 0,
  • "content": "string",
  • "vars_schema": { },
  • "update_user": "string",
  • "update_time": 0
}

List Versions

path Parameters
prompt_id
required
string (Prompt Id)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Rollback

path Parameters
prompt_id
required
string (Prompt Id)
Request Body schema: application/json
required
version
required
integer (Version) >= 1

Responses

Request samples

Content type
application/json
{
  • "version": 1
}

Response samples

Content type
application/json
{
  • "prompt_id": "string",
  • "name": "string",
  • "current_version": 0,
  • "content": "string",
  • "vars_schema": { },
  • "update_user": "string",
  • "update_time": 0
}

Get Effective Prompt

path Parameters
agent_id
required
string (Agent Id)

Responses

Response samples

Content type
application/json
{
  • "source": "override",
  • "content": "string",
  • "prompt_id": "string",
  • "version": 0
}

Put Override

path Parameters
agent_id
required
string (Agent Id)
Request Body schema: application/json
required
content
required
string (Content) non-empty

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "account_id": "string",
  • "source": "override"
}

Delete Override

path Parameters
agent_id
required
string (Agent Id)

Responses

Response samples

Content type
application/json
{
  • "deleted": true,
  • "fallback": "default"
}

Get Thread

path Parameters
thread_id
required
string (Thread Id)

Responses

Response samples

Content type
application/json
{
  • "thread_id": "string",
  • "agent_id": "string",
  • "create_time": 0,
  • "update_time": 0,
  • "messages": [
    ]
}

Export Agents

Request Body schema: application/json
required
agent_ids
required
Array of strings (Agent Ids) non-empty

Responses

Request samples

Content type
application/json
{
  • "agent_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "format": "bkn-agent/v1",
  • "exported_at": 0,
  • "items": [
    ]
}

Import Agents

Request Body schema: application/json
required
required
object (ExportPackage)

Responses

Request samples

Content type
application/json
{
  • "package": {
    }
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "warnings": [
    ]
}

BknAgentExecution

Get Execution

Authorizations:
HTTPBearer
path Parameters
run_id
required
string (Run Id)

Responses

Response samples

Content type
application/json
{
  • "run_id": "string",
  • "agent_id": "string",
  • "thread_id": "string",
  • "status": "pending",
  • "result": { },
  • "error": {
    }
}

Cancel Execution

Authorizations:
HTTPBearer
path Parameters
run_id
required
string (Run Id)

Responses

Response samples

Content type
application/json
{
  • "run_id": "string",
  • "agent_id": "string",
  • "thread_id": "string",
  • "status": "pending",
  • "result": { },
  • "error": {
    }
}

Execute

Authorizations:
HTTPBearer
Request Body schema: application/json
required
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$
message
required
string (Message) [ 1 .. 100000 ] characters
client_request_id
required
string (Client Request Id) [ 1 .. 100 ] characters ^[0-9A-Za-z_.-]+$
Thread Id (string) or Thread Id (null) (Thread Id)
required
object (ExecutionScope)

Responses

Request samples

Content type
application/json
{
  • "agent_id": "string",
  • "message": "string",
  • "client_request_id": "string",
  • "thread_id": "string",
  • "context": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "description": "string",
  • "detail": "string",
  • "solution": "string",
  • "trace_id": "string",
  • "link": ""
}

Get User Setting

Authorizations:
HTTPBearer
path Parameters
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$

Responses

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "setting": {
    },
  • "version": 0,
  • "update_time": 0
}

Put User Setting

Authorizations:
HTTPBearer
path Parameters
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$
Request Body schema: application/json
required
Instruction (string) or Instruction (null) (Instruction)
Array of Allowed Tools (strings) or Allowed Tools (null) (Allowed Tools)
AgentLimits (object) or null

Responses

Request samples

Content type
application/json
{
  • "instruction": "string",
  • "allowed_tools": [
    ],
  • "limits": {
    }
}

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "setting": {
    },
  • "version": 0,
  • "update_time": 0
}

Delete User Setting

Authorizations:
HTTPBearer
path Parameters
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$

Responses

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "setting": {
    },
  • "version": 0,
  • "update_time": 0
}

Get Network Setting

Authorizations:
HTTPBearer
path Parameters
kn_id
required
string (Kn Id) [ 1 .. 128 ] characters ^[0-9A-Za-z_.-]+$
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$

Responses

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "setting": {
    },
  • "version": 0,
  • "update_time": 0
}

Put Network Setting

Authorizations:
HTTPBearer
path Parameters
kn_id
required
string (Kn Id) [ 1 .. 128 ] characters ^[0-9A-Za-z_.-]+$
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$
Request Body schema: application/json
required
Instruction (string) or Instruction (null) (Instruction)
Array of Allowed Tools (strings) or Allowed Tools (null) (Allowed Tools)
AgentLimits (object) or null

Responses

Request samples

Content type
application/json
{
  • "instruction": "string",
  • "allowed_tools": [
    ],
  • "limits": {
    }
}

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "setting": {
    },
  • "version": 0,
  • "update_time": 0
}

Delete Network Setting

Authorizations:
HTTPBearer
path Parameters
kn_id
required
string (Kn Id) [ 1 .. 128 ] characters ^[0-9A-Za-z_.-]+$
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$

Responses

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "setting": {
    },
  • "version": 0,
  • "update_time": 0
}

Get Agent Config

Authorizations:
HTTPBearer
path Parameters
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$
query Parameters
kn_id
required
string (Kn Id) [ 1 .. 128 ] characters ^[0-9A-Za-z_.-]+$

Responses

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "name": "string",
  • "model": "string",
  • "status": "string",
  • "shared": {
    },
  • "network": {
    },
  • "user": {
    },
  • "effective": {
    },
  • "mcp_profile": "string",
  • "can_edit_network": true,
  • "can_edit_shared": true
}

List Shared Agents

Authorizations:
HTTPBearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Shared Agent

Authorizations:
HTTPBearer
path Parameters
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$

Responses

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "name": "string",
  • "model": "string",
  • "status": "string",
  • "limits": {
    },
  • "mcp_profile": "string",
  • "uses_context_loader": true,
  • "tools": [ ],
  • "layered": true,
  • "can_edit": true,
  • "prompt_version": 0,
  • "version": 0,
  • "initial_version": 0,
  • "restorable": true,
  • "modified": true,
  • "update_user": "string",
  • "update_time": 0
}

Update Shared Agent

Authorizations:
HTTPBearer
path Parameters
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$
Request Body schema: application/json
required
Model (string) or Model (null) (Model)
AgentLimits (object) or null
Status (string) or Status (null) (Status)
Mcp Profile (string) or Mcp Profile (null) (Mcp Profile)

Responses

Request samples

Content type
application/json
{
  • "model": "string",
  • "limits": {
    },
  • "status": "draft",
  • "mcp_profile": "full"
}

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "name": "string",
  • "model": "string",
  • "status": "string",
  • "limits": {
    },
  • "mcp_profile": "string",
  • "uses_context_loader": true,
  • "tools": [ ],
  • "layered": true,
  • "can_edit": true,
  • "prompt_version": 0,
  • "version": 0,
  • "initial_version": 0,
  • "restorable": true,
  • "modified": true,
  • "update_user": "string",
  • "update_time": 0
}

List Agent Versions

List configuration history with Prompt bodies in the negotiated request language.

Missing translations fall back to canonical content; raw Prompt history is unchanged.

Authorizations:
HTTPBearer
path Parameters
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Activate Agent Version

Make a version current: its model, tools, limits and Prompt version go back onto the Agent. No new version is written.

Authorizations:
HTTPBearer
path Parameters
version
required
integer (Version) >= 1
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$

Responses

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "name": "string",
  • "model": "string",
  • "status": "string",
  • "limits": {
    },
  • "mcp_profile": "string",
  • "uses_context_loader": true,
  • "tools": [ ],
  • "layered": true,
  • "can_edit": true,
  • "prompt_version": 0,
  • "version": 0,
  • "initial_version": 0,
  • "restorable": true,
  • "modified": true,
  • "update_user": "string",
  • "update_time": 0
}

Delete Agent Version

Remove a version from the history. The current and the initial version stay; a deleted number is never handed out again.

Authorizations:
HTTPBearer
path Parameters
version
required
integer (Version) >= 1
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Restore Shared Agent

Make the initial version current again: what the built-in Agent shipped with. History is kept.

Authorizations:
HTTPBearer
path Parameters
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$

Responses

Response samples

Content type
application/json
{
  • "agent_id": "string",
  • "name": "string",
  • "model": "string",
  • "status": "string",
  • "limits": {
    },
  • "mcp_profile": "string",
  • "uses_context_loader": true,
  • "tools": [ ],
  • "layered": true,
  • "can_edit": true,
  • "prompt_version": 0,
  • "version": 0,
  • "initial_version": 0,
  • "restorable": true,
  • "modified": true,
  • "update_user": "string",
  • "update_time": 0
}

Get Shared Prompt

Authorizations:
HTTPBearer
path Parameters
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$

Responses

Response samples

Content type
application/json
{
  • "prompt": {
    },
  • "next_version": 0,
  • "source_language": "zh-CN",
  • "source_content": "string",
  • "source_content_sha256": "string",
  • "content_language": "zh-CN",
  • "translations": {
    }
}

Publish Shared Prompt

Publish new shared Prompt content; it becomes a new Agent version.

Omit vars_schema to retain the currently active Prompt's variable schema; supply an object to replace it, or explicit null to clear it.

Authorizations:
HTTPBearer
path Parameters
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$
Request Body schema: application/json
required
content
required
string (Content) non-empty ^[\s\S]*[^\u0009-\u000d\u0020\u00a0\u1680\u20...

Must contain a character outside ECMAScript trim whitespace; original formatting is preserved.

Vars Schema (object) or Vars Schema (null) (Vars Schema)
Source Language (string) or Source Language (null) (Source Language)

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "vars_schema": { },
  • "source_language": "zh-CN"
}

Response samples

Content type
application/json
{
  • "prompt": {
    },
  • "next_version": 0,
  • "source_language": "zh-CN",
  • "source_content": "string",
  • "source_content_sha256": "string",
  • "content_language": "zh-CN",
  • "translations": {
    }
}

Publish Shared Prompt Version

Publish exactly the required target Prompt version.

Use next_version from the shared Prompt read response and retain it across retries. An existing or out-of-sequence target returns 409 without creating another Prompt or Agent version. After rollback, next_version still follows the maximum historical version. Omit vars_schema to retain the active schema; an object replaces it and explicit null clears it.

Authorizations:
HTTPBearer
path Parameters
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$
Request Body schema: application/json
required
content
required
string (Content) non-empty ^[\s\S]*[^\u0009-\u000d\u0020\u00a0\u1680\u20...

Must contain a character outside ECMAScript trim whitespace; original formatting is preserved.

Vars Schema (object) or Vars Schema (null) (Vars Schema)
Source Language (string) or Source Language (null) (Source Language)
version
required
integer (Version) [ 1 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "vars_schema": { },
  • "source_language": "zh-CN",
  • "version": 1
}

Response samples

Content type
application/json
{
  • "prompt": {
    },
  • "next_version": 0,
  • "source_language": "zh-CN",
  • "source_content": "string",
  • "source_content_sha256": "string",
  • "content_language": "zh-CN",
  • "translations": {
    }
}

Put Shared Prompt Translation

Add or edit the selected version's translation without creating a version.

An unmarked legacy original is explicitly labeled by the administrator. A changed active version, original body or source language returns 409.

Authorizations:
HTTPBearer
path Parameters
language
required
string (Language)
Enum: "zh-CN" "en-US"
agent_id
required
string (Agent Id) [ 1 .. 50 ] characters ^[0-9A-Za-z_.-]+$
version
required
integer (Version) >= 1
Request Body schema: application/json
required
content
required
string (Content) non-empty ^[\s\S]*[^\u0009-\u000d\u0020\u00a0\u1680\u20...
source_language
required
string (Source Language)
Enum: "zh-CN" "en-US"
source_content_sha256
required
string (Source Content Sha256) ^[0-9a-f]{64}$

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "source_language": "zh-CN",
  • "source_content_sha256": "string"
}

Response samples

Content type
application/json
{
  • "prompt": {
    },
  • "next_version": 0,
  • "source_language": "zh-CN",
  • "source_content": "string",
  • "source_content_sha256": "string",
  • "content_language": "zh-CN",
  • "translations": {
    }
}

BknAgentMetricDesign

Execute Metric Design

Authorizations:
HTTPBearer
Request Body schema: application/json
required
client_request_id
required
string (Client Request Id) [ 1 .. 100 ] characters ^[0-9A-Za-z_.-]+$
Thread Id (string) or Thread Id (null) (Thread Id)
Model Id (string) or Model Id (null) (Model Id)

Optional caller-visible chat model; fixed for the metric-design thread.

required
object (MetricDesignScope)
base_form_revision
required
string (Base Form Revision) [ 1 .. 100 ] characters
required
object (Form Snapshot)
required
object (MetricDesignCandidates)
MetricDesignDiagnostic (object) or null
message
required
string (Message) [ 1 .. 4000 ] characters

Responses

Request samples

Content type
application/json
{
  • "client_request_id": "string",
  • "thread_id": "string",
  • "model_id": "string",
  • "scope": {
    },
  • "base_form_revision": "string",
  • "form_snapshot": { },
  • "candidates": {
    },
  • "diagnostic": {
    },
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "description": "string",
  • "detail": "string",
  • "solution": "string",
  • "trace_id": "string",
  • "link": ""
}

BknAgentInternal

List Authorization Resources

Internal, network-scoped resource directory for bkn-safe.

The resource_type and sort parameters deliberately mirror the other authorization-resource providers even though both supported types share the same authoritative agent table.

query Parameters
resource_type
required
string (Resource Type)
Enum: "agent" "agent_tpl"
name
string (Name)
Default: ""
sort
string (Sort)
Default: "name"
Value: "name"
direction
string (Direction)
Default: "asc"
Enum: "asc" "desc"
offset
integer (Offset) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 20

Responses

Response samples

Content type
application/json
null

Health

Responses

Response samples

Content type
application/json
null