Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Organization

Create an agent version

Create a new version of the given agent. If there's no existing versions, all fields in the request must be filled and they will be used to create the initial version of the agent. Otherwise, only fill the fields that need to be updated, and the new version will retain other fields from the previous latest version.

Permissions

This endpoint requires the following permissions:

  • Organization:CreateAgentVersion for the new version of the agent.
post/v1/{organization}/organization/agent/{agent_id}/

Path parameters

agent_idstring required

The ID of the agent to create a new version for.

The ID of the agent to create a new version for.

organizationstring required

Query parameters

versioninteger nullable

The version number of the new agent version. If specified, this endpoint throws an error if the next version of the agent in the database doesn't equal to the value of this parameter.

The version number of the new agent version. If specified, this endpoint throws an error if the next version of the agent in the database doesn't equal to the value of this parameter.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

initialsstring
backgroundstring
behaviorsAmigoLibPydanticBaseModelStrippedNonemptyString1[] nullable

A list of behavioral guidelines that this agent follows.

communication_patternsAmigoLibPydanticBaseModelStrippedNonemptyString1[] nullable

A list of descriptions that illustrate the communication styles of this agent.

Response

Succeeded.

versioninteger required

Numerical version ID that describes how many iterations of this agent occurred before this version. Note that this is for reference only. Any identification of an agent version in Amigo APIs use the id field.

For initial version of an agent, this field will be 1.

created_atstring date-time required

The time at which this version was created.