Skip to main content
POST
/
api
/
agents
cURL
curl --request POST \
  --url http://localhost:8080/api/agents \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-SECRET: <api-key>' \
  --data '
{
  "page": 0,
  "limit": 20,
  "sort_by": "updated_at",
  "sort_order": "descending",
  "filter_criteria": {
    "agent_name": [
      "search_term"
    ]
  }
}
'
{
  "message": "Agents retrieved successfully",
  "status": "success",
  "error": null,
  "data": {
    "organization_id": "org_123",
    "agents": [],
    "pagination": {},
    "returned_count": 20,
    "sort_order": "descending",
    "sort_by": "updated_at"
  }
}

Authorizations

X-API-KEY
string
header
required

API Key for MCP server and external service authentication

X-API-SECRET
string
header
required

API Secret for MCP server and external service authentication

Body

application/json
page
integer

Page number (default: 0)

limit
integer

Items per page (default: 20, max: 100)

sort_by
string

Sort field (default: updated_at)

sort_order
string

Sort direction (default: descending)

filter_criteria
object

Response

200 - application/json

OK

message
string
status
string
error
string
data
object