Skip to main content
POST
Search Agents

Authorizations

Authorization
string
header
required

Clerk Machine API Key for authentication

Path Parameters

workspace_id
string
required

Body

application/json
farm_id
object

Farm ID filter. Supports exact match (eq) or set membership (in).

Example:
status
object

Agent status filter

Example:
page
integer

Page number, starting at 1

Required range: 1 <= x <= 9007199254740991
Example:

1

limit
integer

Results per page

Required range: 1 <= x <= 10000
Example:

50

Response

Successfully retrieved agents

success
boolean
required

Indicates if the request was successful

Example:

true

data
Agent · object[]
required

Array of items

pagination
object
required

Pagination metadata

error
null
required

Error object (null on success)

Example:

null