Create

POST

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

POST

/api/v1/agents

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

Try it

200Successful

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 }

Create a new agent.

Request

This endpoint expects an object.

namestringOptionalDefaults to Personal AI Agent

The name of an AI Agent

personalitystringOptionalDefaults to

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.

custom_assistant_idstringOptionalDefaults to

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

custom_welcome_messagestringOptionalDefaults to

A custom first message that this agent will send

disable_memorybooleanOptionalDefaults to false

Prevent this agent from passing memory to its graphs.

websitestringOptional

The primary website the AI should use to seed and maintain its knowledge base.

categoryenumOptional

The category of the agent

agent_urlstringOptional

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

agent_capabilitiesstringOptional

Text describing the capabilities of the agent

agent_configobjectOptional

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

place_idstringOptional

A Google Place ID representing the agent’s location.

meta_dataobjectOptional

characterstringOptionalDefaults to Deprecated

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

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