List Agents

GET /api/v1/agents

List agents with their current presence and owner

Python

import requests

url = "https://app.langwatch.ai/api/v1/agents"

headers = {"X-Auth-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "signature",
      "config": {},
      "environment": "<string>",
      "ownerUserId": "<string>",
      "hostLabel": "<string>",
      "lastSeenAt": "2023-11-07T05:31:56Z",
      "parameters": [
        {
          "name": "<string>",
          "description": "<string>",
          "defaultValue": "<string>",
          "secret": true,
          "type": "string",
          "options": [
            "<string>"
          ],
          "required": true
        }
      ],
      "owner": {
        "userId": "<string>",
        "name": "<string>"
      },
      "status": "online",
      "instances": [
        {
          "instanceId": "<string>",
          "hostname": "<string>",
          "username": "<string>",
          "pid": 123,
          "label": "<string>",
          "sdk": {
            "name": "<string>",
            "version": "<string>",
            "language": "<string>"
          },
          "connectedAt": "2023-11-07T05:31:56Z",
          "inflight": 123,
          "maxConcurrency": 123
        }
      ],
      "selectable": true,
      "notSelectableReason": "owned_by_another_person",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "platformUrl": "<string>"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0
  }
}

Authorizations

X-Auth-Token · string · header · required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Query Parameters

page · integer · default: 1

Required range: x <= 9007199254740991

limit · integer · default: 50

Required range: x <= 1000

Response

200 - application/json

Success

data · object[] · required

Show child attributes

pagination · object · required

Show child attributes