Update

PATCH

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

PATCH

/api/v1/agents/:id

1 curl -X PATCH https://api.flockx.io/api/v1/agents/id \
2      -H "Content-Type: application/json" \
3      -d '{}'

Try it

200Updated

1 {
2   "id": "id",
3   "name": "name",
4   "description": "description",
5   "images": {
6     "image_url": "x",
7     "banner_url": "x"
8   },
9   "models": {
10     "logic_model": "anthropic.claude-3-5-sonnet-20240620-v1:0",
11     "chat_model": "anthropic.claude-3-5-sonnet-20240620-v1:0"
12   },
13   "features": {
14     "discover_activity": true,
15     "location_learning": true,
16     "enable_proactive_message": true,
17     "general_web_search": true,
18     "enable_media_capability": true,
19     "telegram": true,
20     "discord": true
21   },
22   "personality": "personality",
23   "organization": {
24     "id": "id",
25     "name": "blackcurrant............................................................................................................................................................................................"
26   },
27   "knowledge_graph": {
28     "id": "id",
29     "name": "name"
30   },
31   "base_prompt": "base_prompt",
32   "core_context": "core_context",
33   "website": "x",
34   "agent_capabilities": "agent_capabilities",
35   "agent_url": "agent_url",
36   "logic_model_temperature": 1,
37   "agent_address": "agent_address",
38   "point_of_interest": {
39     "name": "blackcurrant....................................................................................................................................................................................................................................................",
40     "provider_type": "blackcurrant....................................................................................................................",
41     "street": "blackcurrant....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................",
42     "city": "blackcurrant....................................................................................................................",
43     "state": "blackcurrant....................................................................................................................",
44     "postal_code": "blackcurrant....................................................................................................................................................................................................................................................",
45     "country": "blackcurrant....................................................................................................................",
46     "id": "id",
47     "description": "blackcurrant....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................",
48     "external_id": "blackcurrant....................................................................................................................................................................................................................................................",
49     "location": {
50       "type": "type",
51       "coordinates": [
52         1,
53         1
54       ]
55     },
56     "url": "url",
57     "image_url": "image_url",
58     "metadata": {}
59   },
60   "category": "business_owner",
61   "agent_config": {
62     "type": "managed"
63   },
64   "meta_data": {}
65 }

Update an agent in your organization.

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

namestringOptional

The name of a Personal Sidekick or Community AI (e.g. Penny).

descriptionstringOptional

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

personalitystringOptional

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.

image_urlstringOptional

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.

websitestringOptional

agent_urlstringOptional

The URL made available by a developer to forward traffic to for an agent

telegram_tokenstringOptional

This field is used to set the Telegram API Key that gives your AI access to Telegram. To clear the token, provide an empty string.

telegram_activebooleanOptional

Controls whether the Telegram integration is active. Set to false to temporarily disable Telegram without removing the token.

discord_guild_idstringOptional

This field is used to set the Discord Guild ID that gives your AI access to Discord. To clear the ID, provide an empty string.

discord_activebooleanOptional

Controls whether the Discord integration is active. Set to false to temporarily disable Discord without removing the guild connection.

logic_modelenumOptional

AI model used for logic and tool operations

Allowed values:

logic_model_temperatureintegerOptional

Temperature for the logic model

chat_modelenumOptional

AI model used for conversational responses

Allowed values:

custom_assistant_idstringOptional

Custom assistant identifier for the agent to use - if this is None, use the default one.

custom_welcome_messagestringOptional

A custom first message that this agent will send

agent_capabilitiesstringOptional

Text describing the capabilities of the agent

categoryenumOptional

The category of the agent

discover_activitybooleanOptional

location_learningbooleanOptional

enable_proactive_messagebooleanOptional

general_web_searchbooleanOptional

enable_media_capabilitybooleanOptional

place_idstringOptional

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

meta_dataobjectOptional

Response

Successful Response

idstringformat: "uuid"

namestring

descriptionstring

imagesobject

modelsobject

featuresobject

personalitystringOptionalDefaults to

organizationobjectOptional

Schema for the Organization

knowledge_graphobjectOptional

Knowledge graph for the agent

base_promptstringOptionalDefaults to

core_contextstringOptionalDefaults to

websitestringOptional

agent_capabilitiesstringOptional

agent_urlstringOptional

logic_model_temperatureintegerOptionalDefaults to 0.1

Temperature for the logic model

agent_addressstringOptional

point_of_interestobjectOptional

Location information for the agent.

categoryenumOptional

agent_configobjectOptional

Agent configuration type, either ‘managed’ or ‘agentverse’

meta_dataobjectOptional