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

# Transition Lifecycle

> Transition a collection's storage tier. 'cold' evicts from the vector store (vectors searchable via object storage). 'active' rehydrates back to the vector store. 'archived' permanently removes vectors.



## OpenAPI

````yaml patch /v1/collections/{collection_identifier}/lifecycle
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security:
  - BearerAuth: []
paths:
  /v1/collections/{collection_identifier}/lifecycle:
    patch:
      tags:
        - Collection Lifecycle
      summary: Transition Lifecycle
      description: >-
        Transition a collection's storage tier. 'cold' evicts from the vector
        store (vectors searchable via object storage). 'active' rehydrates back
        to the vector store. 'archived' permanently removes vectors.
      operationId: >-
        transition_lifecycle_v1_collections__collection_identifier__lifecycle_patch
      parameters:
        - name: collection_identifier
          in: path
          required: true
          schema:
            type: string
            description: Collection ID or name
            title: Collection Identifier
          description: Collection ID or name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransitionLifecycleRequest'
        description: >-
          Keys this body does not declare are refused with 422 extra_forbidden
          naming the accepted keys (since 2026-11-02).
        x-unknown-keys:
          until: '2026-11-02'
          then: 422 extra_forbidden
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleStatusResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
          NamespaceHeader: []
components:
  schemas:
    TransitionLifecycleRequest:
      properties:
        lifecycle_state:
          $ref: '#/components/schemas/LifecycleState'
          description: >-
            Target lifecycle state for the collection. active and cold move
            vectors between the live store and object storage; archived is
            terminal. frozen refuses every document write while reads, search
            and export keep working, so a training run can pin the collection.
            Freezing and unfreezing move no data and complete within the
            request.
        async_transition:
          type: boolean
          title: Async Transition
          description: >-
            If False, block until the transition completes. Ignored for frozen,
            which moves no data and always completes within the request.
          default: true
      type: object
      required:
        - lifecycle_state
      title: TransitionLifecycleRequest
    LifecycleStatusResponse:
      properties:
        collection_id:
          type: string
          title: Collection Id
        lifecycle_state:
          $ref: '#/components/schemas/LifecycleState'
        s3_vector_index:
          anyOf:
            - type: string
            - type: 'null'
          title: S3 Vector Index
        vector_document_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Vector Document Count
        s3_vector_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: S3 Vector Count
        last_transitioned_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Transitioned At
        task_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Task Id
        warning:
          anyOf:
            - type: string
            - type: 'null'
          title: Warning
        namespace_storage_tier:
          anyOf:
            - $ref: '#/components/schemas/NamespaceStorageTier'
            - type: 'null'
          description: >-
            The storage rung of the namespace this collection belongs to. Absent
            until the namespace has been rated once.
      type: object
      required:
        - collection_id
        - lifecycle_state
      title: LifecycleStatusResponse
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    LifecycleState:
      type: string
      enum:
        - active
        - cold
        - archived
        - frozen
      title: LifecycleState
    NamespaceStorageTier:
      properties:
        rung:
          type: string
          title: Rung
          description: >-
            The namespace's storage rung: hot, warm, cold or frozen. It moves
            down when the namespace goes unqueried and back to hot after
            sustained queries. A query answers on every rung.
        storage:
          anyOf:
            - type: string
            - type: 'null'
          title: Storage
          description: >-
            The storage class the index files are in (standard, nearline,
            coldline), or autoclass when the bucket chooses its own classes.
        changed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Changed At
          description: When the rung last changed.
      type: object
      required:
        - rung
      title: NamespaceStorageTier
      description: Where the namespace's vector index files sit in object storage.
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Mixpeek API key, sent as `Authorization: Bearer mxp_sk_...`. Create one
        in Studio under Settings → API Keys, or with an admin key via `POST
        /v1/organizations/users/{user_email}/api-keys`. A missing, malformed,
        unknown, revoked, inactive or expired key returns 401; a key without the
        permission, scope or plan an operation needs returns 403.
    NamespaceHeader:
      type: apiKey
      in: header
      name: X-Namespace
      description: >-
        Namespace id (`ns_...`), not the namespace name. This scopes the request
        rather than authenticating it, and it is required on every operation
        marked `x-mixpeek-namespace-scoped`.

````

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