Skip to content
Overmind
Get started
API Reference
Agents

List agents

client.agents.list(AgentListParams { model, name, ordering, 5 more } query?, RequestOptionsoptions?): AgentListResponse { count, results, next, previous }
GET/api/agents/

List agents

ParametersExpand Collapse
query: AgentListParams { model, name, ordering, 5 more }
model?: string
name?: string
ordering?: string

Which field to use when ordering the results.

page?: number

A page number within the paginated result set.

project?: string
formatuuid
slug?: string
status?: string
ReturnsExpand Collapse
AgentListResponse { count, results, next, previous }
count: number
results: Array<Result>
id: string
formatuuid
created_at: string
formatdate-time
name: string
maxLength255
project: string
formatuuid
slug: string
maxLength255
updated_at: string
formatdate-time
agent_path?: string
maxLength512
analyzer_model?: string
maxLength128
dataset_has_expected_output?: boolean
dataset_size?: number
maximum9223372036854776000
minimum-9223372036854776000
formatint64
description?: string
display_name?: string
maxLength512
entrypoint_fn?: string
maxLength255
model?: string
maxLength128
status?: string
maxLength20
structure_weight?: number
formatdouble
tags?: unknown
tool_usage_weight?: number
formatdouble
total_points?: number
formatdouble
List agents
import OvermindLab from 'overmind-lab';

const client = new OvermindLab();

const agents = await client.agents.list();

console.log(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"
}