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

# Get Config

> Get current configuration and resource status.

    Returns a comprehensive view of all configured resources in the system,
    including embedders, language models, rerankers, and databases. Each
    resource includes its current status (ready, failed, or pending) and
    any error messages if initialization failed.

    This endpoint is useful for:
    - Monitoring the health of configured resources
    - Diagnosing startup failures when resources are unavailable
    - Verifying that runtime configuration changes have been applied

    Resources may be in one of three states:
    - `ready`: The resource is initialized and available for use
    - `failed`: The resource failed to initialize (error details included)
    - `pending`: The resource is configured but not yet initialized


## OpenAPI

````yaml /openapi.json get /api/v2/config
openapi: 3.1.0
info:
  title: MemMachine API
  version: 0.3.10
  description: >-
    Architectural Memory Systems for AI Agents. Specialized in episodic and
    semantic memory management with strict namespace isolation.
servers:
  - url: http://localhost:8080
security: []
tags:
  - name: Configuration
    description: System overview and memory subsystem configuration.
  - name: Episodic Configuration
    description: Per-project episodic memory subsystem configuration.
  - name: Memories
    description: Core operations for episodic and semantic memory ingestion and retrieval.
  - name: Projects
    description: Lifecycle management for isolated memory namespaces.
  - name: Resources
    description: Embedder, language model, and reranker lifecycle management.
  - name: 'Semantic Memory: Categories'
    description: Category, template, and tag management for semantic sets.
  - name: 'Semantic Memory: Features'
    description: Add, retrieve, and update individual semantic features.
  - name: 'Semantic Memory: Sets'
    description: Set type and set ID lifecycle, listing, and configuration.
  - name: System
    description: Infrastructure, health, and observability.
paths:
  /api/v2/config:
    get:
      tags:
        - Configuration
      summary: Get Config
      description: |-
        Get current configuration and resource status.

            Returns a comprehensive view of all configured resources in the system,
            including embedders, language models, rerankers, and databases. Each
            resource includes its current status (ready, failed, or pending) and
            any error messages if initialization failed.

            This endpoint is useful for:
            - Monitoring the health of configured resources
            - Diagnosing startup failures when resources are unavailable
            - Verifying that runtime configuration changes have been applied

            Resources may be in one of three states:
            - `ready`: The resource is initialized and available for use
            - `failed`: The resource failed to initialize (error details included)
            - `pending`: The resource is configured but not yet initialized
      operationId: get_config
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResponse'
components:
  schemas:
    GetConfigResponse:
      properties:
        resources:
          $ref: '#/components/schemas/ResourcesStatus'
          description: |2-

                The status of all configured resources.
        episodic_memory:
          $ref: '#/components/schemas/EpisodicMemoryConfigResponse'
          description: |2-

                Current episodic memory configuration including both long-term and short-term memory.
        semantic_memory:
          $ref: '#/components/schemas/SemanticMemoryConfigResponse'
          description: |2-

                Current semantic memory configuration.
      type: object
      required:
        - resources
      title: GetConfigResponse
      description: Response model for configuration retrieval.
    ResourcesStatus:
      properties:
        embedders:
          items:
            $ref: '#/components/schemas/ResourceInfo'
          type: array
          title: Embedders
          description: |2-

                The status of all configured embedders.
        language_models:
          items:
            $ref: '#/components/schemas/ResourceInfo'
          type: array
          title: Language Models
          description: |2-

                The status of all configured language models.
        rerankers:
          items:
            $ref: '#/components/schemas/ResourceInfo'
          type: array
          title: Rerankers
          description: |2-

                The status of all configured rerankers.
        databases:
          items:
            $ref: '#/components/schemas/ResourceInfo'
          type: array
          title: Databases
          description: |2-

                The status of all configured databases.
      type: object
      title: ResourcesStatus
      description: Status of all configured resources.
    EpisodicMemoryConfigResponse:
      properties:
        long_term_memory:
          $ref: '#/components/schemas/LongTermMemoryConfigResponse'
          description: |2-

                Current long-term memory configuration.
        short_term_memory:
          $ref: '#/components/schemas/ShortTermMemoryConfigResponse'
          description: |2-

                Current short-term memory configuration.
        enabled:
          type: boolean
          title: Enabled
          description: |2-

                Whether episodic memory as a whole is enabled.
          default: true
      type: object
      title: EpisodicMemoryConfigResponse
      description: Response model for episodic memory configuration.
    SemanticMemoryConfigResponse:
      properties:
        enabled:
          type: boolean
          title: Enabled
          description: |2-

                Whether semantic memory is enabled. When set to true, the required
                fields (database, llm_model, embedding_model) must also be configured.
                Set to false to disable semantic memory entirely.
          default: false
        database:
          anyOf:
            - type: string
            - type: 'null'
          title: Database
          description: |2-

                The ID of the database to use for semantic memory storage.
                Must reference a database configured in the resources section. Used by
                legacy semantic storage backends.
        storage_backend:
          anyOf:
            - type: string
            - type: 'null'
          title: Storage Backend
          description: |2-

                The storage backend used for semantic memory.
        feature_store:
          anyOf:
            - type: string
            - type: 'null'
          title: Feature Store
          description: |2-

                The ID of the relational database resource used to store semantic feature
                data when the semantic storage backend is `vector_store`.
        vector_collection:
          anyOf:
            - type: string
            - type: 'null'
          title: Vector Collection
          description: |2-

                The ID of the vector store resource used to store semantic feature
                embeddings when the semantic storage backend is `vector_store`.
        llm_model:
          anyOf:
            - type: string
            - type: 'null'
          title: Llm Model
          description: |2-

                The ID of the language model to use for semantic memory extraction.
                Must reference a language model configured in the resources section.
        embedding_model:
          anyOf:
            - type: string
            - type: 'null'
          title: Embedding Model
          description: |2-

                The ID of the embedder to use for semantic memory vector search.
                Must reference an embedder configured in the resources section.
      type: object
      title: SemanticMemoryConfigResponse
      description: Response model for semantic memory configuration.
    ResourceInfo:
      properties:
        name:
          type: string
          title: Name
          description: |2-

                The unique name/identifier of the resource.
        provider:
          type: string
          title: Provider
          description: |2-

                The provider type of the resource (e.g., 'openai', 'amazon-bedrock
        status:
          $ref: '#/components/schemas/ResourceStatus'
          description: |2-

                The current status of the resource.
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
          description: |2-

                The error message if the resource operation failed.
      type: object
      required:
        - name
        - provider
        - status
      title: ResourceInfo
      description: Information about a configured resource.
    LongTermMemoryConfigResponse:
      properties:
        backend:
          anyOf:
            - type: string
              enum:
                - declarative
                - event
            - type: 'null'
          title: Backend
          description: >-
            Long-term memory backend. None means the writer predates the
            discriminator and is treated as 'declarative'.
        embedder:
          anyOf:
            - type: string
            - type: 'null'
          title: Embedder
          description: |2-

                ID of the embedder resource used for long-term memory.
        reranker:
          anyOf:
            - type: string
            - type: 'null'
          title: Reranker
          description: |2-

                ID of the reranker resource used for long-term memory search.
        vector_graph_store:
          anyOf:
            - type: string
            - type: 'null'
          title: Vector Graph Store
          description: |2-

                ID of the vector graph store (database) for storing long-term memories.
        vector_store:
          anyOf:
            - type: string
            - type: 'null'
          title: Vector Store
          description: VectorStore resource id (event backend only)
        segment_store:
          anyOf:
            - type: string
            - type: 'null'
          title: Segment Store
          description: >-
            SQL engine resource id backing the segment store (event backend
            only)
        properties_schema:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          title: Properties Schema
          description: >-
            User-defined filterable properties (event backend only). Maps name
            to type ("bool", "int", "float", "str", "datetime").
        enabled:
          type: boolean
          title: Enabled
          description: |2-

                Whether long-term memory is enabled.
          default: true
      type: object
      title: LongTermMemoryConfigResponse
      description: Response model for long-term memory configuration.
    ShortTermMemoryConfigResponse:
      properties:
        llm_model:
          anyOf:
            - type: string
            - type: 'null'
          title: Llm Model
          description: |2-

                ID of the language model used for short-term memory summarization.
        message_capacity:
          anyOf:
            - type: integer
            - type: 'null'
          title: Message Capacity
          description: |2-

                Maximum message capacity for short-term memory, in characters.
        enabled:
          type: boolean
          title: Enabled
          description: |2-

                Whether short-term memory is enabled.
          default: true
      type: object
      title: ShortTermMemoryConfigResponse
      description: Response model for short-term memory configuration.
    ResourceStatus:
      type: string
      enum:
        - ready
        - failed
        - pending
      title: ResourceStatus
      description: Status of a resource.

````