List

GET

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

GET

/api/v1/agents

1 import requests
2 
3 url = "https://api.flockx.io/api/v1/agents"
4 
5 headers = {"Authorization": "<apiKey>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

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         "general_agent_search": true,
21         "planner_mode": true,
22         "enable_media_capability": true,
23         "telegram": true,
24         "discord": true,
25         "calendar_enabled": true,
26         "whatsapp": true,
27         "sms": true,
28         "asi": true,
29         "agentverse": true,
30         "widget_enabled": true
31       },
32       "personality": "",
33       "personal": true,
34       "knowledge_graph": {
35         "id": "foo",
36         "name": "foo"
37       },
38       "website": "foo",
39       "agent_capabilities": "foo",
40       "logic_model_temperature": 0.1,
41       "agent_address": "foo",
42       "agent_handle": "foo",
43       "point_of_interest": {
44         "name": "foo",
45         "display_name": "foo",
46         "provider_type": "foo",
47         "street": "foo",
48         "city": "foo",
49         "state": "foo",
50         "postal_code": "foo",
51         "country": "foo",
52         "id": "foo",
53         "description": "",
54         "external_id": "foo",
55         "location": {
56           "type": "Point",
57           "coordinates": [
58             42
59           ]
60         },
61         "url": "",
62         "image_url": "",
63         "metadata": {}
64       },
65       "category": "business_owner",
66       "meta_data": {}
67     }
68   ],
69   "meta": {
70     "total": 42,
71     "has_next": true,
72     "has_previous": true,
73     "page": 42
74   }
75 }

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

Authentication

Authorizationstring

API Key authentication via header

Query Parameters

sizeintegerOptional1-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

Authentication

Query Parameters

Response

Errors