Skip to main content
GET
/
agent
List Agents
curl --request GET \
  --url https://api.beamstudio.ai/agent \
  --header 'current-workspace-id: <current-workspace-id>' \
  --header 'x-api-key: <api-key>'
{
  "agents": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "beam-os",
      "creatorId": "<string>",
      "order": 123,
      "description": "<string>",
      "themeIconUrl": "<string>",
      "agentCategoryId": "<string>",
      "category": {
        "id": "<string>",
        "title": "<string>"
      },
      "workspaceId": "<string>"
    }
  ],
  "count": 123
}

Authorizations

x-api-key
string
header
required

Headers

current-workspace-id
string
required

Query Parameters

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

Filter agents by type (beam-os, user-agent, pre-configured-agent)

Available options:
beam-os,
user-agent,
pre-configured-agent
Example:

"beam-os"

searchQuery
string

Search agents by name or description

Example:

"customer support"

agentCategoryId
string

Filter agents by category ID

Example:

"cat_123456"

Response

200 - application/json

List of agents retrieved successfully

agents
object[]
required
count
number
required