Create

Create a new agent.

Request

This endpoint expects an object.

namestringOptional>=1 character<=256 charactersDefaults to Personal AI Agent

The name of an AI 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.

personalitystringOptional<=5000 charactersDefaults 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_welcome_messagestringOptional<=2048 charactersDefaults to

A custom first message that this agent will send

websitestringOptional

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

categoryenum or nullOptional

The category of the agent

agent_capabilitiesstring or nullOptional

Text describing the capabilities of the agent

place_idstring or nullOptional

A Google Place ID representing the agent's location.

meta_datamap from strings to anyOptional

characterstringOptional<=512 charactersDefaults to Deprecated

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

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

point_of_interestobject or null

Location information for the agent.

categoryenum or null

meta_datamap from strings to any or null

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

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	"enable_media_capability": true,
19	"telegram": true,
20	"discord": true,
21	"calendar_enabled": true,
22	"whatsapp": true,
23	"sms": true
24	},
25	"personality": "",
26	"personal": true,
27	"knowledge_graph": {
28	"id": "foo",
29	"name": "foo"
30	},
31	"website": "foo",
32	"agent_capabilities": "foo",
33	"logic_model_temperature": 0.1,
34	"agent_address": "foo",
35	"point_of_interest": {
36	"name": "foo",
37	"display_name": "foo",
38	"provider_type": "foo",
39	"street": "foo",
40	"city": "foo",
41	"state": "foo",
42	"postal_code": "foo",
43	"country": "foo",
44	"id": "foo",
45	"description": "",
46	"external_id": "foo",
47	"location": {
48	"type": "Point",
49	"coordinates": [
50	42
51	]
52	},
53	"url": "",
54	"image_url": "",
55	"metadata": {}
56	},
57	"category": "business_owner",
58	"meta_data": {}
59	}

Headers

Request

Response

Errors