Skip to main content
GET
/
api
/
v3
/
agents
List all agents
curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/agents \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "instructions": "<string>",
      "company": {
        "id": 123,
        "name": "<string>",
        "allow_ephemeral_mode": true,
        "is_sharing_enabled": true
      },
      "group": {
        "name": "<string>",
        "id": 123
      },
      "workspaces": [
        {
          "id": 123,
          "name": "<string>",
          "category": "<string>",
          "file_count": 123,
          "summaries": []
        }
      ],
      "tools": {
        "native": [
          {
            "id": "<string>",
            "name": "<string>",
            "object": "tool"
          }
        ],
        "mcp_servers": [
          {
            "id": "<string>",
            "name": "<string>",
            "object": "mcp_server"
          }
        ]
      },
      "is_default": true,
      "scope_workspaces_by_group": true,
      "is_current_user_favorite": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

company_id
integer

Filter agents by company ID. Sys-admins can filter by any company ID. Company admins and regular users can only filter by their own company ID.

group_id
integer

Filter agents by group ID

is_current_user_favorite
string

Filter agents by favorite status. Accepted values: 'true', 'false', '1', '0', 'yes', 'no'

is_default
string

Filter agents by is_default status. Accepted values: 'true', 'false', '1', '0', 'yes', 'no'

name
string

Filter agents by name (prefix search, case-insensitive)

page
integer

Page number for pagination

page_size
integer

Number of results per page (default: 50, max: 100)

user_id
integer

Filter agents by user ID - returns agents linked to groups of which the specified user is a member. Sys-admins can filter by any user ID. Company admins can only filter by user IDs of users inside their company. Regular users can only filter by their own user ID.

Response

count
integer
required
next
string | null
required
previous
string | null
required
results
object[]
required