v3
ai-agents

Save agent to catalog

Save an existing agent's configuration as a global catalog template. Super admin only.

post/v3/ai-agents/{agent_id}/save-to-catalog

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

agent_idstring uuid required

Headers

mentium-workspace-idstring nullable

Request body

namestring nullable

Override the agent's name in the catalog entry

descriptionstring nullable

Override the agent's description

is_publishedboolean

Whether the entry is immediately visible

Response

Successful Response

idstring required
namestring required
descriptionstring nullable required
agent_typestring required
modelstring required
system_prompt_templatestring required
user_prompt_templatestring nullable required
temperaturenumber nullable required
max_tokensinteger nullable required
reasoning_effortstring nullable required
toolsstring[] required
type_configobject nullable required
is_publishedboolean required
is_system_agentboolean

True when the entry is a system agent installed into workspaces for Chat.

created_by_user_idstring required
source_agent_idstring nullable required
source_organization_idstring nullable required
created_atstring date-time required
updated_atstring date-time required
has_draftboolean

True when the entry has unpublished draft changes.

draftobject nullable

Staged draft changes parsed from the draft row's YAML.

Changes

No recorded changes to this operation across all 2 revisions of this API.