---
title: "Install catalog entry into workspaces"
method: POST
path: "/v3/agent-catalog/{entry_id}/install"
tags: ["agent-catalog"]
---

# Install catalog entry into workspaces

`POST /v3/agent-catalog/{entry_id}/install`

## Request

- Base URL: `https://api.mentium.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mentium.io/v3/agent-catalog/{entry_id}/install`
- Auth: HTTP bearer

Create an editable agent from this entry in every workspace of an organization, or in the given workspaces. Workspaces that already have it are skipped, and so are those whose organization does not have the AGENT_CHAT product feature. SUPER_ADMIN only.

## Path parameters

- `entry_id` string, uuid, required

## Request body

- AgentCatalogInstallRequest: Where to install a catalog entry: every workspace of one organization, or a list of workspaces.
  - `organization_id` string, uuid, nullable: Install into every workspace of this organization
  - `workspace_ids` string[], nullable: Install into these workspaces

## Response `200`

Successful Response

- AgentCatalogInstallResponse: Per-workspace results of installing a catalog entry.
  - `entry_id` string, required
  - `results` AgentCatalogInstallResultOut[], required
    - `workspace_id` string, required
    - `agent_id` string, nullable: The workspace's agent installed from this entry
    - `status` 'created' | 'already_installed' | 'skipped' | 'failed', required: created; already_installed (the workspace already had a copy); skipped (its organization does not have AGENT_CHAT); failed (see error)
    - `created` boolean, required: False when the workspace already had the agent, or on error
    - `error` string, nullable: Why the agent could not be created in this workspace

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/mentium/apis/mentium-api.md) - [All operations](https://skmtc.dev/mentium/apis/mentium-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mentium/apis/mentium-api/revisions/b4ed8e59432e?raw)