---
title: "Update a catalog"
method: PATCH
path: "/v1/catalogs/:catalog_key"
---

# Update a catalog

`PATCH /v1/catalogs/:catalog_key`

Update fields on a catalog.

## Path parameters

- `catalog_key` string, required

## Request body

- object — Catalog fields to update.
  - `agent_context` string — Agent-specific context for this catalog. Note - this context is passed to canvases within this catalog. To update context for canvases consuming this catalog, add AGENTS.md files to the catalog instead.
  - `description` string — A description of the catalog.
  - `name` string — The display name for the catalog

## Response `200`

Successful response

- object — Base response envelope for all successful API responses.
  - `success` true, required
  - `request_id` string, required
  - `result` Catalog, required — A catalog
    - `key` string, required — The unique identifier for the catalog
    - `name` string, required — The display name for the catalog
    - `created_at` string, date-time, required — An ISO 8601 date-time string.
    - `description` string, required — A description of the catalog.
    - `modified_at` string, date-time, required — An ISO 8601 date-time string.
    - `permissions` object[], required — The list of actors with assigned permissions for this catalog.
      - `key` string, required — The unique identifier for the actor.
      - `role` union, required — A catalog role.
        - 'admin' — Catalog admin.
        - 'analyst' — Catalog analyst.
        - 'editor' — Catalog editor.
        - 'viewer' — Catalog viewer.
        - 'presentation_viewer' — Catalog presentation viewer.
      - `type` union, required — The type of actor.
        - 'user' — A workspace member
        - 'group' — A workspace group
        - 'service_account' — A service account
        - 'workspace' — All workspace members
    - `sources` object[], required — The connections that this catalog can access.
      - `connection_key` string, required — The unique identifier for the connection
      - `connection_name` string, required — The display name for the connection
    - `agent_context` string — Agent-specific context for this catalog. Note - this context is passed to canvases within this catalog. To update context for canvases consuming this catalog, add AGENTS.md files to the catalog instead.

## Other responses

- `4XX` — Client error. Possible status codes include: 400 (invalid request), 401 (missing or invalid API key), 403 (insufficient permissions), 404 (resource not found), 429 (rate limit exceeded).
- `5XX` — Internal server error.

---

[API](https://skmtc.net/count/apis/count-public-api.md) · [All operations](https://skmtc.net/count/apis/count-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/count/count-public-api/versions/858ed44750ff/schema)