Create

Create a new agent.

Headers

AuthorizationstringRequired

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

Errors