Update | Flockx - Your Team of AIs

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<=20000 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)

point_of_interest_idstring or nullOptionalformat: "uuid"

The id of a Point of Interest representing the agent’s location. Resolve or create one via POST /v2/points_of_interest, then pass its id here. Takes precedence over the deprecated place_id.

general_agent_searchboolean or nullOptional

Enable agent search functionality for discovering other agents

meta_datamap from strings to any or nullOptional

place_idstring or nullOptionalDeprecated

DEPRECATED: Use point_of_interest_id instead. A Google Place ID representing the agent’s location. Providing an empty string will clear the location.

Response

Successful Response

idstringformat: "uuid"

namestring

descriptionstring

organizationobject or null

Schema for the Organization

imagesobject

featuresobject

personalitystringOptionalDefaults to

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.

knowledge_graphobject or nullOptional

Knowledge graph for the agent

websitestringOptional

agent_capabilitiesstring or nullOptional

logic_model_temperaturedoubleOptionalDefaults to 0.1

Temperature for the logic model

agent_addressstring or nullOptional

agent_handlestring or nullOptional

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

voice_idstringOptionalDefaults to jqcCZkN6Knx8BJ5TBdYR

ElevenLabs voice ID used for TTS playback of this agent's responses.

point_of_interestobject or nullOptional

Location information for the agent.

categoryenum or nullOptional

interest_tagslist of stringsOptional

meta_datamap from strings to anyOptional

Errors

422

Unprocessable Entity Error

$	curl -X PATCH https://api.flockx.io/api/v1/agents/id \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

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	"voice_id": "jqcCZkN6Knx8BJ5TBdYR",
46	"point_of_interest": {
47	"name": "foo",
48	"display_name": "foo",
49	"provider_type": "foo",
50	"street": "foo",
51	"city": "foo",
52	"state": "foo",
53	"postal_code": "foo",
54	"country": "foo",
55	"id": "foo",
56	"description": "",
57	"external_id": "foo",
58	"location": {
59	"type": "Point",
60	"coordinates": [
61	42
62	]
63	},
64	"url": "",
65	"image_url": "",
66	"metadata": {}
67	},
68	"category": "business_owner",
69	"interest_tags": [
70	"foo"
71	],
72	"meta_data": {}
73	}