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: <apiKey>"

Try it

200Retrieved

1 {
2   "items": [
3     {
4       "id": "foo",
5       "name": "foo",
6       "description": "foo",
7       "organization": {
8         "id": "foo",
9         "name": "foo"
10       },
11       "images": {
12         "image_url": "foo",
13         "banner_url": "foo"
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         "calendar_enabled": true
24       },
25       "personality": "",
26       "personal": true,
27       "knowledge_graph": {
28         "id": "foo",
29         "name": "foo"
30       },
31       "website": "foo",
32       "agent_capabilities": "foo",
33       "logic_model_temperature": 0.1,
34       "agent_address": "foo",
35       "point_of_interest": {
36         "name": "foo",
37         "display_name": "foo",
38         "provider_type": "foo",
39         "street": "foo",
40         "city": "foo",
41         "state": "foo",
42         "postal_code": "foo",
43         "country": "foo",
44         "id": "foo",
45         "description": "",
46         "external_id": "foo",
47         "location": {
48           "type": "Point",
49           "coordinates": [
50             42
51           ]
52         },
53         "url": "",
54         "image_url": "",
55         "metadata": {}
56       },
57       "category": "business_owner",
58       "meta_data": {}
59     }
60   ],
61   "meta": {
62     "total": 42,
63     "has_next": true,
64     "has_previous": true,
65     "page": 42
66   }
67 }

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

Query parameters

sizeintegerOptional>=1<=100Defaults to 50

pageintegerOptional>=1Defaults to 1

sort_orderenum or nullOptional

Sort order (asc or desc)

Allowed values:

querystring or nullOptionalDefaults to

Response

Successful Response

itemslist of objects

metaobject

List

Headers

Query parameters

Response

Errors