List

GET

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

GET

/api/v1/agents

1 curl https://api.flockx.io/api/v1/agents \
2      -H "Authorization: <Authorization>"

Try it

200listAgentsExample

1 {
2   "items": [
3     {
4       "id": "foo",
5       "name": "foo",
6       "description": "foo",
7       "images": {
8         "image_url": "foo",
9         "banner_url": "foo"
10       },
11       "features": {
12         "discover_activity": true,
13         "location_learning": true,
14         "enable_proactive_message": true,
15         "general_web_search": true,
16         "enable_media_capability": true,
17         "telegram": true,
18         "discord": true
19       },
20       "personality": "",
21       "organization": {
22         "id": "foo",
23         "name": "foo"
24       },
25       "knowledge_graph": {
26         "id": "foo",
27         "name": "foo"
28       },
29       "website": "foo",
30       "agent_capabilities": "foo",
31       "agent_address": "foo",
32       "point_of_interest": {
33         "name": "foo",
34         "display_name": "foo",
35         "provider_type": "foo",
36         "street": "foo",
37         "city": "foo",
38         "state": "foo",
39         "postal_code": "foo",
40         "country": "foo",
41         "id": "foo",
42         "description": "",
43         "external_id": "foo",
44         "location": {
45           "type": "Point",
46           "coordinates": [
47             42
48           ]
49         },
50         "url": "",
51         "image_url": "",
52         "metadata": {}
53       },
54       "category": "business_owner",
55       "meta_data": {}
56     }
57   ],
58   "meta": {
59     "total": 42,
60     "has_next": true,
61     "has_previous": true,
62     "page": 42
63   }
64 }

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

List

Headers

Query parameters

Response

Errors