Update | Flockx API Documentation

Update an agent in your organization.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

namestring or nullOptional1-256 characters

The name of the AI Agent (e.g. Penny).

descriptionstring or nullOptional<=512 characters

Describe how your AI looks (e.g. surfing seal).

personalitystring or nullOptional<=10000 characters

Describe how your AI acts and behaves. This is used to generate the base prompt of your AI. The base prompt is what gives personality to how your AI responds and interacts with users.

selected_personalitystring or nullOptionalformat: "uuid"

The ID of the Persona that is currently selected for this agent.

personalboolean or nullOptionalDefaults 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.

image_urlstring or nullOptional

Image of the AI, this is the image that appears as the profile picture of the AI. If this AI is connected to a Community then this image will be the Community's profile picture too.

websitestring or nullOptional

logic_model_temperaturedouble or nullOptional

Temperature for the logic model

custom_welcome_messagestring or nullOptional

A custom first message that this agent will send

agent_capabilitiesstring or nullOptional

Text describing the capabilities of the agent

categoryenum or nullOptional

The category of the agent

interest_tagslist of strings or nullOptional

Interest tags for agent discovery (max 10)

place_idstring or nullOptional

A Google Place ID representing the agent's location. Providing an empty string will clear the location.

general_agent_searchboolean or nullOptional

Enable agent search functionality for discovering other agents

meta_datamap from strings to any or nullOptional

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

interest_tagslist of strings or null

meta_datamap from strings to any or null

1	import requests
2
3	url = "https://api.flockx.io/api/v1/agents/id"
4
5	payload = {}
6	headers = {
7	"Authorization": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.patch(url, json=payload, headers=headers)
12
13	print(response.json())

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

Authentication

Path parameters

Request

Response

Errors