Skip to content
Overmind
Get started
API Reference
Agents

List agents

agents.list(AgentListParams**kwargs) -> AgentListResponse
GET/api/agents/

List agents

ParametersExpand Collapse
model: Optional[str]
name: Optional[str]
ordering: Optional[str]

Which field to use when ordering the results.

page: Optional[int]

A page number within the paginated result set.

project: Optional[str]
formatuuid
slug: Optional[str]
status: Optional[str]
ReturnsExpand Collapse
class AgentListResponse: …
count: int
results: List[Result]
id: str
formatuuid
created_at: datetime
formatdate-time
name: str
maxLength255
project: str
formatuuid
slug: str
maxLength255
updated_at: datetime
formatdate-time
agent_path: Optional[str]
maxLength512
analyzer_model: Optional[str]
maxLength128
dataset_has_expected_output: Optional[bool]
dataset_size: Optional[int]
maximum9223372036854776000
minimum-9223372036854776000
formatint64
description: Optional[str]
display_name: Optional[str]
maxLength512
entrypoint_fn: Optional[str]
maxLength255
model: Optional[str]
maxLength128
status: Optional[str]
maxLength20
structure_weight: Optional[float]
formatdouble
tags: Optional[object]
tool_usage_weight: Optional[float]
formatdouble
total_points: Optional[float]
formatdouble
List agents
from overmind_lab import OvermindLab

client = OvermindLab()
agents = client.agents.list()
print(agents.count)
{
  "count": 123,
  "results": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "project": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "slug": "slug",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "agent_path": "agent_path",
      "analyzer_model": "analyzer_model",
      "dataset_has_expected_output": true,
      "dataset_size": -9007199254740991,
      "description": "description",
      "display_name": "display_name",
      "entrypoint_fn": "entrypoint_fn",
      "model": "model",
      "status": "status",
      "structure_weight": 0,
      "tags": {},
      "tool_usage_weight": 0,
      "total_points": 0
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}
Returns Examples
{
  "count": 123,
  "results": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "project": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "slug": "slug",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "agent_path": "agent_path",
      "analyzer_model": "analyzer_model",
      "dataset_has_expected_output": true,
      "dataset_size": -9007199254740991,
      "description": "description",
      "display_name": "display_name",
      "entrypoint_fn": "entrypoint_fn",
      "model": "model",
      "status": "status",
      "structure_weight": 0,
      "tags": {},
      "tool_usage_weight": 0,
      "total_points": 0
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}