> ## Documentation Index
> Fetch the complete documentation index at: https://synthlabs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Update package metadata

> Update allowed mutable metadata or visibility without rewriting immutable version history.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/v1/users/{user_id}/registry/packages/{kind}/{package_id}
openapi: 3.1.0
info:
  title: Synth API Reference
  version: 2026-08-23.alpha
  description: HTTP API for your account, tasks, datasets, agent runs and usage.
servers:
  - url: https://sprites-gateway.api.synthlabs.ai
    description: Synth API
security: []
tags:
  - name: Identity
    description: Manage customer tokens without exposing internal service credentials.
  - name: Registry
    description: >-
      Create, discover, set visibility, version, execute, and inspect results
      for Harbor-compatible tasks and datasets.
  - name: Managed execution
    description: Validate, run, observe, and retrieve Harbor-compatible managed work.
  - name: Usage
    description: Inspect authoritative current rolling quota.
paths:
  /api/v1/users/{user_id}/registry/packages/{kind}/{package_id}:
    patch:
      tags:
        - Registry
      summary: Update package metadata
      description: >-
        Update allowed mutable metadata or visibility without rewriting
        immutable version history.
      operationId: updateRegistryPackage
      parameters:
        - in: path
          name: user_id
          required: true
          schema:
            format: uuid
            title: User Id
            type: string
        - in: path
          name: kind
          required: true
          schema:
            $ref: '#/components/schemas/PackageKind'
        - in: path
          name: package_id
          required: true
          schema:
            format: uuid
            title: Package Id
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegistryPackagePatch'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistryCatalogItem'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - UserBearer: []
components:
  schemas:
    PackageKind:
      enum:
        - task
        - dataset
      title: PackageKind
      type: string
    RegistryPackagePatch:
      additionalProperties: false
      description: Deliberately bounded package metadata and publication mutation.
      properties:
        description:
          anyOf:
            - maxLength: 2000
              type: string
            - type: 'null'
          title: Description
        display_name:
          anyOf:
            - maxLength: 255
              minLength: 1
              type: string
            - type: 'null'
          title: Display Name
        visibility:
          anyOf:
            - $ref: '#/components/schemas/PackageVisibility'
            - type: 'null'
      title: RegistryPackagePatch
      type: object
    RegistryCatalogItem:
      additionalProperties: false
      description: Safe package summary without storage, actor, or tenant identifiers.
      properties:
        access:
          $ref: '#/components/schemas/RegistryCatalogAccess'
        canonical_ref:
          maxLength: 511
          minLength: 3
          title: Canonical Ref
          type: string
        created_at:
          format: date-time
          title: Created At
          type: string
        current_version_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Current Version Id
        description:
          anyOf:
            - maxLength: 2000
              type: string
            - type: 'null'
          title: Description
        display_name:
          anyOf:
            - maxLength: 255
              type: string
            - type: 'null'
          title: Display Name
        id:
          format: uuid
          title: Id
          type: string
        kind:
          $ref: '#/components/schemas/PackageKind'
        mutable:
          title: Mutable
          type: boolean
        name:
          maxLength: 255
          minLength: 1
          title: Name
          type: string
        namespace:
          maxLength: 255
          minLength: 1
          title: Namespace
          type: string
        updated_at:
          format: date-time
          title: Updated At
          type: string
        visibility:
          $ref: '#/components/schemas/PackageVisibility'
      required:
        - id
        - kind
        - namespace
        - name
        - canonical_ref
        - visibility
        - access
        - mutable
        - created_at
        - updated_at
      title: RegistryCatalogItem
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    PackageVisibility:
      enum:
        - private
        - org
        - public
      title: PackageVisibility
      type: string
    RegistryCatalogAccess:
      description: Why the authenticated customer can read one package.
      enum:
        - owned
        - organization
        - public
      title: RegistryCatalogAccess
      type: string
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    UserBearer:
      description: Synth customer access token for the current user and organization.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.