Detail | Flockx API Documentation

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

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

Get details of an agent in your organization.

Authentication

Authorizationstring

API Key authentication via header

Path Parameters

idstringRequiredformat: "uuid"

Response

Successful Response

idstringformat: "uuid"

namestring

descriptionstring

organizationobject or null

Schema for the Organization

imagesobject

featuresobject

personalitystring or nullDefaults to

personalboolean or nullDefaults to false

Is the agent a personal agent or a public agent. If personal is true the agent will not be listed on marketplaces, if it false then it will be.

knowledge_graphobject or null

Knowledge graph for the agent

websitestring or null

agent_capabilitiesstring or null

logic_model_temperaturedouble or nullDefaults to 0.1

Temperature for the logic model

agent_addressstring or null

agent_handlestring or null

Agentverse handle for the agent (e.g. ‘my-agent-handle’ for @my-agent-handle.av)

point_of_interestobject or null

Location information for the agent.

categoryenum or null

meta_datamap from strings to any or null

Authentication

Path Parameters

Response

Errors