Skip to content
Discord

Templates

Create template (Cloud-only)
client.templates.create(TemplateCreateParamsbody, RequestOptionsoptions?): TemplateCreateResponse { id, latest_version, name, 5 more }
POST/v1/templates
Save template version (Cloud-only)
client.templates.save(stringtemplateName, TemplateSaveParams { block_reconciliation_strategy, message, migrate_agents, 3 more } body?, RequestOptionsoptions?): TemplateSaveResponse { id, latest_version, name, 5 more }
POST/v1/templates/{template_name}/save
Delete template (Cloud-only)
client.templates.delete(stringtemplateName, TemplateDeleteParamsbody?, RequestOptionsoptions?): TemplateDeleteResponse { success }
DELETE/v1/templates/{template_name}
Update current template from agent file (Cloud-only)
client.templates.update(stringtemplateName, TemplateUpdateParams { agent_file_json, save_existing_changes, update_existing_tools } body, RequestOptionsoptions?): TemplateUpdateResponse { success, message }
PATCH/v1/templates/{template_name}
Rollback template to previous version (Cloud-only)
client.templates.rollback(stringtemplateName, TemplateRollbackParams { version } body, RequestOptionsoptions?): TemplateRollbackResponse { success, message }
POST/v1/templates/{template_name}/rollback
ModelsExpand Collapse
TemplateCreateResponse { id, latest_version, name, 5 more }
id: string
latest_version: string

The latest version of the template

name: string

The exact name of the template

project_id: string
project_slug: string
template_deployment_slug: string

The full name of the template, including version and project slug

updated_at: string

When the template was last updated

description?: string
TemplateSaveResponse { id, latest_version, name, 5 more }
id: string
latest_version: string

The latest version of the template

name: string

The exact name of the template

project_id: string
project_slug: string
template_deployment_slug: string

The full name of the template, including version and project slug

updated_at: string

When the template was last updated

description?: string
TemplateDeleteResponse { success }
success: boolean
TemplateUpdateResponse { success, message }
success: boolean
message?: string
TemplateRollbackResponse { success, message }
success: boolean
message?: string

TemplatesAgents

Create Agents From Template
client.templates.agents.create(stringtemplateVersion, AgentCreateParams { agent_name, identity_ids, initial_message_sequence, 3 more } body?, RequestOptionsoptions?): AgentCreateResponse { agent_ids, deployment_id, group_id }
POST/v1/templates/{template_version}/agents
ModelsExpand Collapse
AgentCreateResponse { agent_ids, deployment_id, group_id }

Response containing created agent IDs and associated metadata

agent_ids: Array<string>

Array of created agent IDs

deployment_id: string

The deployment ID for the created agents

group_id: string | null

Optional group ID if agents were created in a group