Skip to main content
GET
/
agent-views
List all views
curl --request GET \
  --url https://api.beamlearning.io/agent-views \
  --header 'Authorization: Bearer <token>' \
  --header 'current-workspace-id: <current-workspace-id>'
{
  "views": [
    {
      "id": "<string>",
      "agentId": "<string>",
      "name": "<string>",
      "isActive": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "agent": {
        "id": "<string>",
        "name": "<string>",
        "iconUrl": "<string>"
      },
      "description": "<string>",
      "columns": [
        {
          "id": "<string>",
          "name": "<string>",
          "dataType": "string",
          "agentGraphNodeId": "<string>",
          "paramType": "input",
          "paramName": "<string>",
          "position": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "linkedAgentViewId": "<string>",
          "linkedView": {
            "id": "<string>",
            "name": "<string>"
          },
          "linkType": "<string>",
          "linkMatchSourceColumn": {
            "id": "<string>",
            "name": "<string>",
            "paramType": "input"
          },
          "linkMatchTargetColumn": {
            "id": "<string>",
            "name": "<string>",
            "paramType": "input"
          },
          "reverseColumnId": "<string>"
        }
      ]
    }
  ],
  "total": 123
}

Authorizations

Authorization
string
header
required

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

Headers

current-workspace-id
string
required

Query Parameters

agentId
string

Filter by agent ID

Search by view name or description

pageNum
number
Required range: x >= 1
pageSize
number
Required range: 1 <= x <= 100

Response

200 - application/json
views
object[]
required
total
number
required