List

GET

https://api.flockx.io/api/v1/agents

GET

/api/v1/agents

1 curl https://api.flockx.io/api/v1/agents

Try it

200Retrieved

1 {
2   "items": [
3     {
4       "id": "id",
5       "name": "name",
6       "description": "description",
7       "images": {
8         "image_url": "x",
9         "banner_url": "x"
10       },
11       "models": {
12         "logic_model": "anthropic.claude-3-5-sonnet-20240620-v1:0",
13         "chat_model": "anthropic.claude-3-5-sonnet-20240620-v1:0"
14       },
15       "features": {
16         "discover_activity": true,
17         "location_learning": true,
18         "enable_proactive_message": true,
19         "general_web_search": true,
20         "enable_media_capability": true,
21         "telegram": true,
22         "discord": true
23       },
24       "personality": "personality",
25       "organization": {
26         "id": "id",
27         "name": "blackcurrant............................................................................................................................................................................................"
28       },
29       "knowledge_graph": {
30         "id": "id",
31         "name": "name"
32       },
33       "base_prompt": "base_prompt",
34       "core_context": "core_context",
35       "website": "x",
36       "agent_capabilities": "agent_capabilities",
37       "agent_url": "agent_url",
38       "logic_model_temperature": 1,
39       "agent_address": "agent_address",
40       "point_of_interest": {
41         "name": "blackcurrant....................................................................................................................................................................................................................................................",
42         "provider_type": "blackcurrant....................................................................................................................",
43         "street": "blackcurrant....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................",
44         "city": "blackcurrant....................................................................................................................",
45         "state": "blackcurrant....................................................................................................................",
46         "postal_code": "blackcurrant....",
47         "country": "blackcurrant....................................................................................................................",
48         "id": "id",
49         "description": "blackcurrant....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................",
50         "external_id": "blackcurrant....................................................................................................................................................................................................................................................",
51         "location": {
52           "type": "type"
53         },
54         "url": "url",
55         "image_url": "image_url",
56         "metadata": {}
57       },
58       "category": "business_owner",
59       "agent_config": {
60         "type": "managed"
61       },
62       "meta_data": {}
63     },
64     {
65       "id": "id",
66       "name": "name",
67       "description": "description",
68       "images": {
69         "image_url": "x",
70         "banner_url": "x"
71       },
72       "models": {
73         "logic_model": "anthropic.claude-3-5-sonnet-20240620-v1:0",
74         "chat_model": "anthropic.claude-3-5-sonnet-20240620-v1:0"
75       },
76       "features": {
77         "discover_activity": true,
78         "location_learning": true,
79         "enable_proactive_message": true,
80         "general_web_search": true,
81         "enable_media_capability": true,
82         "telegram": true,
83         "discord": true
84       },
85       "personality": "personality",
86       "organization": {
87         "id": "id",
88         "name": "blackcurrant............................................................................................................................................................................................"
89       },
90       "knowledge_graph": {
91         "id": "id",
92         "name": "name"
93       },
94       "base_prompt": "base_prompt",
95       "core_context": "core_context",
96       "website": "x",
97       "agent_capabilities": "agent_capabilities",
98       "agent_url": "agent_url",
99       "logic_model_temperature": 1,
100       "agent_address": "agent_address",
101       "point_of_interest": {
102         "name": "blackcurrant....................................................................................................................................................................................................................................................",
103         "provider_type": "blackcurrant....................................................................................................................",
104         "street": "blackcurrant....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................",
105         "city": "blackcurrant....................................................................................................................",
106         "state": "blackcurrant....................................................................................................................",
107         "postal_code": "blackcurrant....",
108         "country": "blackcurrant....................................................................................................................",
109         "id": "id",
110         "description": "blackcurrant....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................",
111         "external_id": "blackcurrant....................................................................................................................................................................................................................................................",
112         "location": {
113           "type": "type"
114         },
115         "url": "url",
116         "image_url": "image_url",
117         "metadata": {}
118       },
119       "category": "business_owner",
120       "agent_config": {
121         "type": "managed"
122       },
123       "meta_data": {}
124     }
125   ],
126   "meta": {
127     "total": 1,
128     "has_next": true,
129     "has_previous": true,
130     "page": 1
131   }
132 }

List, search, and filter for an agent in your organization.

Query parameters

sizeintegerOptional>=1<=100Defaults to 50

pageintegerOptional>=1Defaults to 1

sort_orderenumOptional

Sort order (asc or desc)

Allowed values:

querystringOptionalDefaults to

Response

Successful Response

itemslist of objects

metaobject