List Agents

POST

https://api.getzep.com/api/v4/agents/list

POST

/api/v4/agents/list

from zep_cloud import Zep
client = Zep(
    api_key="YOUR_API_KEY_HERE",
)
client.agent.list()

{
  "items": [
    {
      "agent_id": "string",
      "created_at": "string",
      "deployment_id": "string",
      "description": "string",
      "memory_settings": {
        "admission_evaluation_requirements": [
          {
            "requirements": [
              {
                "evaluated_by": "string",
                "evaluator_version": "string",
                "result": "string",
                "controlled": true,
                "environment": "string"
              }
            ],
            "task_family": "string"
          }
        ],
        "approval": "manual",
        "approval_minimum_attempt_families": 1,
        "approval_required_tools": [
          "string"
        ],
        "auto_approval_task_families": [
          "string"
        ],
        "compilation_mode": "scheduled",
        "provisional_expiry_days": 1,
        "provisional_skill_limit": 1,
        "retention_days": 1
      },
      "metadata": {},
      "name": "string",
      "revision": 1,
      "security_domain": "string",
      "status": "active",
      "updated_at": "string",
      "uuid": "string",
      "version": "string"
    }
  ],
  "next_cursor": "string",
  "total_size": 1
}

Authentication

AuthorizationApi-Key

Type “Api-Key” followed by a space and the project API key.

Query parameters

page_sizeintegerOptional1-100Defaults to 50

The maximum number of items in one page. The SDK method returns a pager. In Python, .items holds only the first page. In TypeScript, .data holds only the first page. To read every page, iterate the pager: use for or list(...) in Python, or for await in TypeScript. In Go, the method returns one page, and Iterator() reads all pages.

cursorstringOptional

Opaque page cursor

order_byenumOptional

Sort field

Allowed values:

orderenumOptional

asc or desc

Allowed values:

Request

Filters

agent_idstringOptional

Filters to the exact developer-assigned Agent identifier.

deployment_idstringOptional

Filters to the exact deployment identifier.

metadatamap from strings to anyOptional

Filters to Agents whose metadata contains these key-value pairs.

searchstringOptional

Filters to Agents whose name, Agent identifier, deployment identifier, or deployment version contains this text. Matching is case-insensitive.

statusenumOptional

Filters to lifecycle status. Omit to include every status.

Allowed values:

versionstringOptional

Filters to the exact deployment version.

Response

itemslist of objectsOptional

The Agents on this page.

next_cursorstringOptional

Opaque cursor for retrieving the next page, present only when more results are available.

total_sizeintegerOptional

The total number of Agents matching the filters and authorization scope.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error