Sign in
templates

Create agents from a template (Cloud-only)

Creates an Agent or multiple Agents from a template

post/v1/templates/{project}/{template_version}/agents

Path parameters

projectstring required

The project slug

template_versionstring required

The template version, formatted as {template-name}:{version-number} or {template-name}:latest

Request body

tagsstring[]

The tags to assign to the agent

agent_namestring

The name of the agent, optional otherwise a random one will be assigned

memory_variablesobject

The memory variables to assign to the agent

tool_variablesobject

The tool variables to assign to the agent

identity_idsstring[]

The identity ids to assign to the agent

Response

201

deployment_idstring required

The deployment ID of the created agents, group and blocks, can be used to identify from a specific invokation

Example response

{
  "agents": [
    {
      "memory": {
        "blocks": [
          {
            "id": "block-123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "file_blocks": [
          {
            "id": "block-123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      },
      "tools": [
        {
          "id": "tool-123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "sources": [
        {
          "id": "source-123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "tool_exec_environment_variables": [
        {
          "id": "agent-env-123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "secrets": [
        {
          "id": "agent-env-123e4567-e89b-12d3-a456-426614174000"
        }
      ]
    }
  ]
}

Changes