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

> ## Agent Instructions
> Describe what the running code does. Do not invent hosted pricing, launch dates, or security guarantees. Share and viewer links are a configured base URL plus an artifact path. Show localhost and a placeholder origin such as https://library.example.com.

# Rename an artifact

> Owner only. Changes the library name and leaves the HTML object, content revision, access, organization, and share columns unchanged. The creator is the only caller who can rename. Organization role is not consulted, so an organization admin who did not create the artifact cannot rename it. A missing id and a caller who is not the creator, including a member who can read an org_shared artifact, return the same 404 as an unknown id. Cookie-authenticated writes need an allowed Origin.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/v1/artifacts/{id}/name
openapi: 3.1.0
info:
  title: Factrove HTTP API
  version: 0.1.0
  description: >-
    Generated from `@factrove/contracts` schemas and the HTTP operation catalog.
    Product routes live under `/api/v1`. Auth and API key management live under
    `/api/auth`. Do not treat this file as hand-written. Run `pnpm docs:openapi`
    after contract or route-catalog changes.
servers:
  - url: http://localhost:3001
    description: Local development API origin
  - url: https://api.example.com
    description: Example self-hosted API origin
security: []
tags:
  - name: Health
    description: Process liveness.
  - name: Auth
    description: Sessions and API keys.
  - name: Artifacts
    description: Upload, list, rename, delete, detail, and content.
  - name: Shares
    description: Owner public-link and password controls.
  - name: Public
    description: Anonymous share detail, unlock, and HTML.
paths:
  /api/v1/artifacts/{id}/name:
    patch:
      tags:
        - Artifacts
      summary: Rename an artifact
      description: >-
        Owner only. Changes the library name and leaves the HTML object, content
        revision, access, organization, and share columns unchanged. The creator
        is the only caller who can rename. Organization role is not consulted,
        so an organization admin who did not create the artifact cannot rename
        it. A missing id and a caller who is not the creator, including a member
        who can read an org_shared artifact, return the same 404 as an unknown
        id. Cookie-authenticated writes need an allowed Origin.
      operationId: renameArtifact
      parameters:
        - name: id
          in: path
          required: true
          description: Artifact UUID.
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      requestBody:
        required: true
        description: >-
          The new library name. This route does not change access or content,
          and it cannot clear a name.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenameArtifactRequest'
            example:
              name: Launch notes
      responses:
        '200':
          description: The same artifact with the new name.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactEnvelope'
              example:
                artifact:
                  id: 11111111-1111-4111-8111-111111111111
                  creatorUserId: user_example
                  organizationId: null
                  accessType: private
                  filename: 11111111-1111-4111-8111-111111111111.html
                  name: Launch notes
                  mimeType: text/html
                  sizeBytes: 527
                  createdAt: '2026-10-21T12:00:00.000Z'
                  updatedAt: '2026-10-21T12:00:00.000Z'
                  uploadedAt: '2026-10-21T12:00:00.000Z'
                  viewerUrl: >-
                    http://localhost:3000/artifacts/11111111-1111-4111-8111-111111111111
                  contentUrl: >-
                    http://localhost:3001/api/v1/artifacts/11111111-1111-4111-8111-111111111111/content
                  shared: false
                  passwordProtected: false
        '400':
          description: >-
            The rename body must be { "name": "<library name>" } and nothing
            else. An invalid name is NFC-normalized, then rejected when it
            contains U+0000–U+001F, U+007F–U+009F, U+2028, or U+2029 before
            trimming, or when the trimmed value is not 1 to 120 Unicode code
            points. That response is `400 INVALID_REQUEST` with message `name
            must be one line of 1 to 120 characters.` A JSON array or any other
            object shape is `400 INVALID_REQUEST` with message `Send { "name":
            "<library name>" }. The name is one line of 1 to 120 characters.`
            Malformed JSON, null, and JSON primitives are `400 INVALID_REQUEST`
            with message `The request is invalid.` A body whose media type is
            not application/json is `400 INVALID_REQUEST` with message `Send
            JSON with Content-Type application/json.` A path id that fails UUID
            validation is also `400 INVALID_REQUEST`. A body larger than 102,400
            bytes is `413 FILE_TOO_LARGE` with message `The request is too
            large.`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                error:
                  code: INVALID_REQUEST
                  message: Artifact id must be a UUID.
        '401':
          description: Missing credentials. Code `UNAUTHENTICATED`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                error:
                  code: UNAUTHENTICATED
                  message: Sign in to continue.
        '403':
          description: Cookie write from a disallowed origin. Code `FORBIDDEN`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                error:
                  code: FORBIDDEN
                  message: This request origin is not allowed.
        '404':
          description: >-
            Unknown artifact, or the caller is not the owner. An organization
            admin or another member who can read the artifact gets this same
            body. Code `ARTIFACT_NOT_FOUND`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                error:
                  code: ARTIFACT_NOT_FOUND
                  message: Artifact was not found.
        '413':
          description: >-
            The JSON body is larger than 102,400 bytes. Code `FILE_TOO_LARGE`
            with message `The request is too large.`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                error:
                  code: FILE_TOO_LARGE
                  message: The request is too large.
        '500':
          description: 'JSON error envelope `{ error: { code, message } }`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                error:
                  code: INTERNAL_ERROR
                  message: An unexpected error occurred.
      security:
        - bearerAuth: []
        - sessionCookie: []
components:
  schemas:
    RenameArtifactRequest:
      type: object
      properties:
        name:
          type: string
      required:
        - name
      additionalProperties: false
    ArtifactEnvelope:
      type: object
      properties:
        artifact:
          type: object
          properties:
            id:
              type: string
              format: uuid
              pattern: >-
                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            creatorUserId:
              type: string
            organizationId:
              anyOf:
                - type: string
                - type: 'null'
            accessType:
              type: string
              enum:
                - private
                - org_shared
            filename:
              type: string
            name:
              description: Library name. Null when the artifact has no name.
              anyOf:
                - type: string
                  minLength: 1
                  maxLength: 120
                - type: 'null'
            mimeType:
              type: string
              const: text/html
            sizeBytes:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            createdAt:
              type: string
              format: date-time
              pattern: >-
                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
            updatedAt:
              type: string
              format: date-time
              pattern: >-
                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
            uploadedAt:
              type: string
              format: date-time
              pattern: >-
                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
            viewerUrl:
              type: string
              format: uri
            contentUrl:
              type: string
              format: uri
            shared:
              type: boolean
            passwordProtected:
              type: boolean
          required:
            - id
            - creatorUserId
            - organizationId
            - accessType
            - filename
            - name
            - mimeType
            - sizeBytes
            - createdAt
            - updatedAt
            - uploadedAt
            - viewerUrl
            - contentUrl
            - shared
            - passwordProtected
          additionalProperties: false
      required:
        - artifact
      additionalProperties: false
    ApiError:
      type: object
      properties:
        error:
          type: object
          required:
            - code
            - message
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - INVALID_REQUEST
                - ORGANIZATION_REQUIRED
                - ORGANIZATION_CHANGED
                - UNAUTHENTICATED
                - PASSWORD_REQUIRED
                - PASSWORD_INCORRECT
                - FORBIDDEN
                - ARTIFACT_NOT_FOUND
                - CONTENT_CONFLICT
                - FILE_TOO_LARGE
                - CONTENT_TOO_LARGE
                - UNSUPPORTED_FILE_TYPE
                - CONTENT_TOO_COMPLEX
                - RATE_LIMITED
                - INTERNAL_ERROR
                - STORAGE_UNAVAILABLE
                - CONVERSION_UNAVAILABLE
                - UNLOCK_UNAVAILABLE
              description: >-
                400/404 INVALID_REQUEST: The request is missing a required
                field, has the wrong shape, or failed validation. Typical causes
                are a missing file, an invalid access type, view, format, or
                artifact id, or invalid UTF-8. Unmatched non-public product
                routes also return 404 INVALID_REQUEST with message Not found.
                400 ORGANIZATION_REQUIRED: The caller asked to share with an
                organization but has no current organization membership. Upload
                with accessType org_shared and PATCH /api/v1/artifacts/{id} for
                a private artifact both use this code. 409 ORGANIZATION_CHANGED:
                PATCH /api/v1/artifacts/{id} for a private artifact named an
                organizationId that is not the caller's current membership when
                the conditional UPDATE reads, or a deadlock, serialization
                failure, or lock timeout persisted after one retry. The artifact
                is not written. That UPDATE is the linearization point: an
                authorization change that commits after its snapshot can land
                before commit and does not cancel the share. About 16 seconds is
                the budget for the two attempts, not an endpoint deadline. An
                artifact that is already org_shared returns 200 instead. 401
                UNAUTHENTICATED: The product route needs a session cookie or
                Authorization: Bearer API key, and neither was accepted. PATCH
                /api/v1/artifacts/{id} also returns this when the session was
                revoked or expired before the conditional update read it, and
                does not write. A revocation that commits after that snapshot
                does not cancel the share. 401 PASSWORD_REQUIRED: The public
                share is password protected and the request did not present a
                valid unlock grant or content ticket. 401 PASSWORD_INCORRECT:
                The password sent to the public unlock route did not match. 403
                FORBIDDEN: A cookie-authenticated write used an Origin or
                Referer that is not WEB_ORIGIN or PUBLIC_BASE_URL. 404
                ARTIFACT_NOT_FOUND: The artifact id is unknown, the caller
                cannot read it, or the public share token is not active. Rename
                and delete also use this body when the caller is not the
                creator, including an organization admin or another member who
                can read an org_shared artifact. Those cases share this body.
                409 CONTENT_CONFLICT: Another replace of the same artifact
                revision finished first. Upload again to replace the current
                content. Delete returns this code when concurrent replaces
                prevent deletion after eight attempts. Retry DELETE. 413
                FILE_TOO_LARGE: The upload is larger than the 10 MiB HTML limit.
                A JSON body larger than 102,400 bytes uses the same code with
                message The request is too large. 413 CONTENT_TOO_LARGE: Stored
                HTML is larger than the Markdown conversion input limit. 415
                UNSUPPORTED_FILE_TYPE: The upload is not a .html or .htm file.
                422 CONTENT_TOO_COMPLEX: Markdown conversion exceeded its time,
                memory, nesting, or output limit. 429 RATE_LIMITED: Too many
                public views from one client address, or too many password
                attempts. Password-attempt 429 responses include Retry-After.
                Public-view 429 responses do not. 500 INTERNAL_ERROR: An
                unexpected persistence or service failure. 503
                STORAGE_UNAVAILABLE: Object storage failed. A failed upload
                leaves no artifact row. A failed artifact delete keeps the row.
                The object may already be gone, so retry DELETE. 503
                CONVERSION_UNAVAILABLE: The Markdown conversion worker pool is
                full. This response does not include Retry-After. 503
                UNLOCK_UNAVAILABLE: Password verification is busy because the
                process-wide Argon2 gate is saturated or every remaining share
                check slot is in flight. Includes Retry-After.
            message:
              type: string
      required:
        - error
      additionalProperties: false
      description: >-
        Product error envelope. Better Auth `/api/auth` routes may return a
        different JSON shape.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Factrove API key, usually prefixed `ftrv_`. Send `Authorization: Bearer
        <key>`. Product routes do not accept `x-api-key` as a credential. A
        present Authorization header that is not a valid key does not fall back
        to the session cookie.
    sessionCookie:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: >-
        Better Auth session cookie from email/password sign-in. On an https API
        origin the name is `__Secure-better-auth.session_token`. On http it is
        `better-auth.session_token`. Host-only unless AUTH_COOKIE_DOMAIN is set.
        Use a cookie jar instead of typing the name.

````

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