POST
/
{resourceSlug}
/
forms
/
agent
/
add

Path Parameters

resourceSlug
string
required

The resourceSlug is a url parameter of the teamId associated with the user

Body

agent.json

An agent object used for tasks or apps

_id
string
required

Unique Mongodb identifier for the object

name
string
required

Name of the agent

role
string
required

Fed into the LLM to help it provide a more detailed and correct response

goal
string
required

The goal of the agent is fed into the LLM, this allows the LLM to know it's role in the RAG pipeline

backstory
string
required

A detailed description of what the LLM will be doing

modelId
string
required

The linked ObjectId of the model being used by this agent (this links to a Model object)

verbose
boolean
required

True or false check to determine if custom verbosity is used in agent, higher verbosity requires agent to include more of the retrieved documents at the expense of longer answers, lower verbosity can result in shorter answers but can also ommit crucial details

allowDelegation
boolean
required

True or false check to determine if the agent is allowed to delegate tasks to other agents in the context of an app

orgId
string

Organisation the agent is linked to (generally the org of the user that created the agent)

teamId
string

Team the agent is linked to (generally the team of the user that created the agent)

functionModelId
string

A secondary model used to execute function calls (this links to a Model object), set to null if unused automatically by the API

toolIds
string[]

Array of the tools the agent can access to improve performance and abstract tool functionality from agent usage

icon
object

IconAttachment object used to hold the attached icon used for the agent (this links to an IconAttachment object);

Response

302 - dynamicResponse

Server response after successsfully adding a new object

_id
string

The unique Mongo id of the newly inserted object.

redirect
string

a string containing the redirect link to get all objects after a successful insertion.