Get Agent

POST

/api/v1/indices/rag/app/get

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/app/get" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "aid-8f3a1b2c4d5e6f70",
    "agent_version": "beta"
}'

{
  "request_id": "f6a7b8c9-d0e1-2345-fabc-456789012345",
  "status_code": 200,
  "code": "Success",
  "message": "",
  "status": "SUCCESS",
  "success": true,
  "data": {
    "agent_id": "aid-8f3a1b2c4d5e6f70",
    "agent_name": "Customer Service Q&A Assistant",
    "agent_desc": "Intelligent customer service Q&A agent based on product documentation",
    "agent_scene": "chat",
    "agent_status": "deployed",
    "create_time": "2026-07-10T14:30:00",
    "modify_time": "2026-07-15T09:15:00",
    "agent_details": [
      {
        "agent_version": "beta",
        "agent_version_desc": "Draft version",
        "publish_time": null,
        "agent_config": {
          "agent_policy": "agentic",
          "agent_model": "qwen3.7-plus",
          "enable_session_file": "false",
          "enable_refusal": "true",
          "enable_anti_leak": "false",
          "enable_rich_text": "false",
          "enable_citation": "true",
          "temperature": 0.5,
          "kb_search_configs": [
            {
              "id": "pipeline-xxxxxx",
              "weight": 1,
              "credibility_level": "high",
              "dense_similarity_top_k": 10,
              "rerank_top_n": 5,
              "rerank_min_score": 0.3,
              "rerank": {
                "model_name": "gte-rerank-hybrid",
                "rerank_mode": "qa"
              }
            }
          ]
        }
      }
    ]
  }
}

Get detailed Agent information, optionally specifying a particular version; when agent_version is not passed, all version details are returned.

Passing "release" as agent_version is not supported.

Authorizations

string

header

required

DashScope API Key, obtained from the API Key page in the console.

Body

application/json

string

required

Agent ID.

string

Specify a version number (beta or a number such as 1). If not provided, all version information is returned.

Response

200-application/json

string

Unique request identifier. Provide this ID when troubleshooting issues.

integer

HTTP status code.

string

Response code. Success on success.

string

Informational message.

enum<string>

Request status: SUCCESS or FAILED.

Available options:SUCCESS,FAILED

boolean

Whether the request succeeded.

object

Show child attributes

string

Agent ID.

string

Agent name.

string

Agent description.

string

Agent scene: chat or search.

string

Agent status.

string

Creation time (ISO 8601).

string

Modification time (ISO 8601).

object[]

List of Agent version details. Returns all versions when agent_version is not specified.

Show child attributes

string

Version number, beta or a number (e.g. 1, 2).

string

Version description.

string

Publish time (ISO 8601). Not present for the beta version.

object

Agent configuration object. If not provided, default configuration is used.

Show child attributes

string

Model name used by the agent, e.g. qwen3.7-plus, qwen3.6-plus.

string

Agent policy, e.g. agentic.

boolean

Whether to enable the anti-leak feature, true or false.

boolean

Whether to enable citation annotations, true or false.

boolean

Whether to enable the refusal feature, true or false.

boolean

Whether to enable rich text output, true or false.

boolean

Whether to enable the session file feature, true or false.

object

Global fusion rerank config (search scene).

Show child attributes

string

Fusion rerank model code. For VL knowledge bases, only multimodal models are supported; otherwise all rerank models are supported.

string

Fusion rerank mode: qa, similar, or custom. rerank_instruct is automatically cleared when not in custom mode.

string

Custom fusion rerank instruction, only effective when rerank_mode is custom. Max 500 characters.

Required range:length <= 500

object[]

List of knowledge base retrieval configurations.

Show child attributes

string

Knowledge base credibility level, e.g. high, medium, low.

integer

Top-K quantity returned by dense retrieval.

string

Associated knowledge base Pipeline ID.

object

Reranking configuration.

Show child attributes

string

Reranking model name, e.g. gte-rerank-hybrid.

string

Custom rerank instruction, only effective when rerank_mode is custom. Max 500 characters.

string

Rerank mode: qa (question answering), similar (similarity), or custom (custom instruction). rerank_instruct is automatically cleared when not in custom mode.

number

Minimum rerank score threshold. Chunks with a score below this value are filtered out.

integer

Top-N quantity retained after reranking.

unknown[]

Retrieval filter conditions, validated against the knowledge base schema.

integer

Sparse retrieval Top K. Range [1, 100].

Required range:1 <= x <= 100

number

Knowledge base weight.

string

Knowledge Base name.

string

Knowledge Base description.

boolean

Whether query rewriting is enabled for this Knowledge Base.

integer

Maximum generation tokens. Must be >= 1.

Required range:x >= 1

integer

Maximum number of LLM calls for the agent.

integer

Fusion rerank Top N (search scene). Range [1, 20].

Required range:1 <= x <= 20

integer

Maximum parsing length for session files. Must be less than the model's max_context_length.

Required range:x >= 1

number

Model sampling temperature, range [0, 2].

string

Anti-leak prompt.

string

Refusal prompt.

string

Credibility prompt.

boolean

Whether thinking mode is enabled.

boolean

Whether a custom temperature is applied.

boolean

Whether credibility checking is enabled.

boolean

Whether the max completion tokens limit is applied.

string

Parsing mode for session files.

string

Custom system prompt for the chat scene. Place it at the top level of agent_config; it is passed through without validation, and its length and effect are determined by the downstream runtime. Note the field name is user_system_prompt, not system_prompt.

string

User who published the version.