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

# Get Settings

> Get the current system settings.

This endpoint retrieves the current configuration settings for the system,
including LLM (Large Language Model) configuration and vector database
configuration. These settings determine how the system processes and stores data.

## Response
Returns the current system settings containing:
- **llm**: LLM configuration (provider, model, API key)
- **vector_db**: Vector database configuration (provider, URL, API key)

## Error Codes
- **500 Internal Server Error**: Error retrieving settings



## OpenAPI

````yaml /cognee_openapi_spec.json get /api/v1/settings
openapi: 3.1.0
info:
  title: Cognee API
  description: Cognee API with Bearer token and Cookie auth
  version: 1.0.0
servers:
  - url: https://{tenant}.aws.cognee.ai
    description: 'Cognee Cloud: your tenant pod, named in the platform.cognee.ai dashboard'
    variables:
      tenant:
        default: your-tenant
        description: Your tenant name, shown in the Cognee Cloud dashboard
  - url: http://localhost:8000
    description: 'Self-hosted: a locally running cognee server'
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: activity
    description: >-
      Activity endpoints for inspecting pipeline runs, traced spans, tenant
      users, agents, and dataset exports.
  - name: add
    description: Data ingestion endpoints for adding text, files, and structured data.
  - name: agent connections
    description: >-
      Endpoints for registering, unregistering, and inspecting agent connections
      to the instance.
  - name: agent management
    description: Endpoints for creating, listing, retrieving, and deleting agents.
  - name: auth
    description: >-
      Authentication endpoints for user registration, login, and token
      management.
  - name: checks
    description: >-
      Diagnostic endpoint for validating a Cognee Cloud API key supplied in the
      X-Api-Key header.
  - name: cognify
    description: >-
      Knowledge processing endpoints to transform raw data into knowledge
      graphs.
  - name: configuration
    description: >-
      Endpoints for storing, retrieving, and listing a user's saved
      configurations.
  - name: datasets
    description: Dataset management endpoints for listing, creating, and deleting datasets.
  - name: delete
    description: Data deletion endpoints (deprecated — use datasets endpoints instead).
  - name: forget
    description: Endpoint for removing data from the knowledge graph.
  - name: health
    description: Liveness, readiness, and component health checks.
  - name: improve
    description: Endpoint for enriching and improving an existing knowledge graph.
  - name: integrations
    description: >-
      Endpoints for connecting, provisioning, and disconnecting OAuth providers
      and plugins.
  - name: llm
    description: >-
      LLM-backed endpoints for inferring graph schemas and generating custom
      extraction prompts.
  - name: memify
    description: >-
      Endpoint for running enrichment pipelines over existing graphs or supplied
      data.
  - name: ontologies
    description: >-
      Endpoints for uploading, listing, and deleting ontology files used during
      cognify.
  - name: permissions
    description: Permission management for multi-user access control.
  - name: recall
    description: >-
      Endpoints for querying the knowledge graph and reviewing past recall
      history.
  - name: remember
    description: >-
      Endpoints for ingesting data into the knowledge graph and storing session
      memory entries.
  - name: responses
    description: Response generation endpoints using the knowledge graph.
  - name: schema
    description: >-
      Schema inspection endpoints for a dataset's derived schema inventory and
      the caller-wide memory provenance graph.
  - name: search
    description: Search endpoints for querying the knowledge graph.
  - name: sessions
    description: >-
      Endpoints for listing sessions and reporting usage, cost, and token
      statistics.
  - name: settings
    description: Configuration endpoints for managing Cognee settings.
  - name: skills
    description: >-
      Skill management endpoints for ingesting, listing, retrieving, and
      deleting dataset skills, plus read-only retrieval of improvement
      proposals.
  - name: slack
    description: >-
      Endpoints for listing workspace channels, setting channel allowlists, and
      linking Slack accounts.
  - name: sync
    description: Endpoints for syncing local data to Cognee Cloud and checking sync status.
  - name: update
    description: Endpoint for updating existing data in a dataset.
  - name: users
    description: User management endpoints.
  - name: validate
    description: >-
      Diagnostic endpoint for checking consistency between a dataset's graph and
      vector stores.
  - name: visualize
    description: Graph visualization endpoints.
paths:
  /api/v1/settings:
    get:
      tags:
        - settings
      summary: Get Settings
      description: >-
        Get the current system settings.


        This endpoint retrieves the current configuration settings for the
        system,

        including LLM (Large Language Model) configuration and vector database

        configuration. These settings determine how the system processes and
        stores data.


        ## Response

        Returns the current system settings containing:

        - **llm**: LLM configuration (provider, model, API key)

        - **vector_db**: Vector database configuration (provider, URL, API key)


        ## Error Codes

        - **500 Internal Server Error**: Error retrieving settings
      operationId: get_settings_api_v1_settings_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsDTO'
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    SettingsDTO:
      properties:
        llm:
          $ref: '#/components/schemas/LLMConfigOutputDTO'
        vectorDb:
          $ref: '#/components/schemas/VectorDBConfigOutputDTO'
      type: object
      required:
        - llm
        - vectorDb
      title: SettingsDTO
    LLMConfigOutputDTO:
      properties:
        apiKey:
          anyOf:
            - type: string
            - type: 'null'
          title: Apikey
        model:
          type: string
          title: Model
        provider:
          type: string
          title: Provider
        endpoint:
          anyOf:
            - type: string
            - type: 'null'
          title: Endpoint
        apiVersion:
          anyOf:
            - type: string
            - type: 'null'
          title: Apiversion
        models:
          additionalProperties:
            items:
              $ref: '#/components/schemas/ConfigChoice'
            type: array
          type: object
          title: Models
        providers:
          items:
            $ref: '#/components/schemas/ConfigChoice'
          type: array
          title: Providers
      type: object
      required:
        - apiKey
        - model
        - provider
        - endpoint
        - apiVersion
        - models
        - providers
      title: LLMConfigOutputDTO
    VectorDBConfigOutputDTO:
      properties:
        apiKey:
          type: string
          title: Apikey
        url:
          type: string
          title: Url
        provider:
          type: string
          title: Provider
        providers:
          items:
            $ref: '#/components/schemas/ConfigChoice'
          type: array
          title: Providers
      type: object
      required:
        - apiKey
        - url
        - provider
        - providers
      title: VectorDBConfigOutputDTO
    ConfigChoice:
      properties:
        value:
          type: string
          title: Value
        label:
          type: string
          title: Label
      type: object
      required:
        - value
        - label
      title: ConfigChoice
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

````