Query system agent configuration

Query the configuration of the specified system agent in the workspace.

GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/system-agent-setups/{agent_id}

Before you call

The example below uses $AI_STUDIO_API_KEY (personal access token), $WORKSPACE_ID (workspace ID), and $AGENT_ID (system agent ID).

The path parameters are workspace_id (target workspace ID) and agent_id (system agent ID). Both values must match the URL and the X-Workspace-ID header.

Request example

curl "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/system-agent-setups/$AGENT_ID" -H "X-API-Key: $AI_STUDIO_API_KEY" -H "X-Workspace-ID: $WORKSPACE_ID"

Successful response

Returns 200 and system agent configuration on success.

{"code":0,"data":{"agent_id":"agent_01"}}

The response fields are as follows.

Field

Type

Description

data.agent_id

string

System agent ID.

Error response

{"code":5,"message":"not found"}
Last updated on