GET
/
agents
Python
from datagrid_ai import Datagrid

client = Datagrid(
    api_key="My API Key",
)
page = client.agents.list()
page = page.data[0]
print(page.id)
{
  "object": "list",
  "data": [
    {
      "system_prompt": "<string>",
      "agent_model": "magpie-1",
      "llm_model": "gemini-1.5-flash-001",
      "knowledge_ids": [
        "<string>"
      ],
      "agent_tools": [
        "data_analysis"
      ],
      "disabled_agent_tools": [
        "data_analysis"
      ],
      "custom_prompt": "<string>",
      "planning_prompt": "<string>",
      "object": "agent",
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:20

The limit on the number of objects to return, ranging between 1 and 100.

Required range: 1 <= x <= 100
​
after
string

A cursor to use in pagination. after is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo to fetch the next page of the list.

​
before
string

A cursor to use in pagination. before is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include before=obj_bar to fetch the previous page of the list.

Response

200 - application/json

List of agents

The response is of type object.