curl --request POST \
--url https://{api-address}.org.machina.gg/agent/search \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"filters": {},
"sorters": [
"name",
1
],
"page": 1,
"page_size": 10
}
'{
"data": [
{
"_id": "67e09cb441dc71ef8db3992f",
"name": "my-new-agent",
"title": "My New Agent",
"description": "Your agent description",
"status": "inactive",
"context": {
"config-frequency": 0.04
},
"workflows": [
{
"name": "sync-nba-embeds",
"description": "sync-nba-embeds",
"inputs": {
"event_code": "$.get('event_code') or None"
},
"outputs": {
"sync-nba-embeds-status": "$.get('workflow-status', False)"
}
}
],
"created": "Sun, 23 Mar 2025 23:43:48 GMT",
"date": "Sun, 23 Mar 2025 23:43:48 GMT"
}
],
"status": true,
"total_documents": 1
}Search for an agent using sort, filter and pagination.
curl --request POST \
--url https://{api-address}.org.machina.gg/agent/search \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"filters": {},
"sorters": [
"name",
1
],
"page": 1,
"page_size": 10
}
'{
"data": [
{
"_id": "67e09cb441dc71ef8db3992f",
"name": "my-new-agent",
"title": "My New Agent",
"description": "Your agent description",
"status": "inactive",
"context": {
"config-frequency": 0.04
},
"workflows": [
{
"name": "sync-nba-embeds",
"description": "sync-nba-embeds",
"inputs": {
"event_code": "$.get('event_code') or None"
},
"outputs": {
"sync-nba-embeds-status": "$.get('workflow-status', False)"
}
}
],
"created": "Sun, 23 Mar 2025 23:43:48 GMT",
"date": "Sun, 23 Mar 2025 23:43:48 GMT"
}
],
"status": true,
"total_documents": 1
}API key authentication
Successful operation
Show child attributes
Unique identifier of the agent
"67e09cb441dc71ef8db3992f"
Unique name of the agent
"my-new-agent"
Display title of the agent
"My New Agent"
Description of the agent's purpose
"Your agent description"
Current status of the agent
active, inactive "inactive"
Configuration settings for the agent
{ "config-frequency": 0.04 }List of workflows associated with the agent
Show child attributes
Name of the workflow
"sync-nba-embeds"
Description of the workflow
"sync-nba-embeds"
Input mappings for the workflow
{
"event_code": "$.get('event_code') or None"
}Output mappings for the workflow
{
"sync-nba-embeds-status": "$.get('workflow-status', False)"
}Creation timestamp
"Sun, 23 Mar 2025 23:43:48 GMT"
Date of creation
"Sun, 23 Mar 2025 23:43:48 GMT"
Operation status
true
Total number of documents matching the query
1