List a room's agents

GET

https://astropods.com/api/v1/accounts/:account/rooms/:room_id/agents

GET

/api/v1/accounts/:account/rooms/:room_id/agents

curl https://astropods.com/api/v1/accounts/account/rooms/room_id/agents \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "agents": [
    {
      "added_at": "2024-01-15T09:30:00Z",
      "avatar_url": "string",
      "connections": [
        {
          "provided_at": "2024-01-15T09:30:00Z",
          "provided_by_user_id": "string",
          "provider": "string",
          "reason": "string",
          "required": true,
          "scopes": [
            "string"
          ]
        }
      ],
      "deployment_id": "string",
      "display_name": "string",
      "mesh": {
        "description": "string",
        "jobs": [
          {
            "description": "string",
            "name": "string"
          }
        ],
        "online": true
      },
      "name": "string",
      "ready": true
    }
  ]
}

Authentication

AuthorizationBearer

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

Path parameters

accountstringRequired

Account name

room_idstringRequired

Room ID

Response

agentslist of objectsOptional