Skip to main content
GET
/
agent
List all agents
curl --request GET \
  --url https://api.example.com/agent/ \
  --header 'x-user-id: <x-user-id>'
{
  "agents": [
    {
      "user_id": "<string>",
      "data": {
        "name": "<string>",
        "system_prompt": "<string>",
        "context_config": {
          "trigger_ratio": 0.8,
          "reserve_ratio": 0.1,
          "compression_prompt": "<system-hint>You have been working on the task described above but have not yet completed it. Now write a continuation summary that will allow you to resume work efficiently in a future context window where the conversation history will be replaced with this summary. Your summary should be structured, concise, and actionable.</system-hint>",
          "summary_template": "<system-info>Here is a summary of your previous work\n# Task Overview\n{task_overview}\n\n# Current State\n{current_state}\n\n# Important Discoveries\n{important_discoveries}\n\n# Next Steps\n{next_steps}\n\n# Context to Preserve\n{context_to_preserve}</system-info>",
          "summary_schema": {},
          "tool_result_limit": 3000
        },
        "react_config": {
          "max_iters": 20,
          "stop_on_reject": false
        },
        "id": "<string>"
      },
      "id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.agentscope.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

x-user-id
string
required

Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.

Response

Successful Response

Response body for listing agents.

agents
AgentRecord · object[]
required

Agent records.

total
integer
required

Total number of agents.