Skip to main content
GET
/
api
/
v1
/
agent
/
search
Search for agents by name or description
curl --request GET \
  --url https://api.example.com/api/v1/agent/search \
  --header 'Authorization: Bearer <token>'
[
  {
    "agentTemplates": "<string>",
    "description": "<string>",
    "documentation": "<string>",
    "icon": "<string>",
    "image": "aSDinaTvuI8gbWludGxpZnk=",
    "inputParameters": {},
    "id": 123,
    "isActive": true,
    "lastActivity": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "proxyPoolId": 123,
    "spaceId": 123,
    "startUrl": "<string>",
    "status": 123,
    "userId": 123,
    "version": 123,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

API Key authorization header. Example: "Authorization: ApiKey {your-api-key}"

​
Authorization
string
header
required

OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"

Query Parameters

​
query
string

The search term to match against agent names and descriptions

​
maxRecords
integer<int32>

Maximum number of results to return. Defaults to 50, max 1000.

​
includeArchived
boolean
default:false

Response

Returns the list of matching agents

​
agentTemplates
string | null
​
configType
enum<integer>
Available options:
1,
2,
3,
4
​
description
string | null
​
documentation
string | null
​
icon
string | null
​
image
string<byte> | null
​
inputParameters
object
​
id
integer<int32> | null
​
isActive
boolean
read-only
​
lastActivity
string<date-time> | null
​
name
string | null
​
proxyPoolId
integer<int32> | null
​
spaceId
integer<int32> | null
​
startUrl
string | null
​
status
integer<int32> | null
​
userId
integer<int32> | null
​
validationStatus
enum<integer>
Available options:
1,
2,
3
​
version
integer<int32>
​
created
string<date-time>
​
updated
string<date-time>