Cognee Settings API

System configuration (LLM and vector DB)

Operations 2

GET /api/v1/settings Get Settings #
POST /api/v1/settings Save Settings #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/cognee:cognee-settings-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cognee-settings-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cognee Settings 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: Settings
  description: Configuration endpoints for managing Cognee settings.
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: []
    post:
      tags:
      - Settings
      summary: Save Settings
      description: 'Save or update system settings.


        This endpoint allows updating the system configuration settings. You can

        update either the LLM configuration, vector database configuration, or both.

        Only provided settings will be updated; others remain unchanged.


        ## Request Parameters

        - **llm** (Optional[LLMConfigInputDTO]): LLM configuration (provider, model, API key)

        - **vector_db** (Optional[VectorDBConfigInputDTO]): Vector database configuration (provider, URL, API key)


        ## Response

        No content returned on successful save.


        ## Error Codes

        - **403 Forbidden**: Caller is not a superuser

        - **400 Bad Request**: Invalid settings provided

        - **500 Internal Server Error**: Error saving settings'
      operationId: save_settings_api_v1_settings_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettingsPayloadDTO'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - BearerAuth: []
      - ApiKeyAuth: []
components:
  schemas:
    ConfigChoice:
      properties:
        value:
          type: string
          title: Value
        label:
          type: string
          title: Label
      type: object
      required:
      - value
      - label
      title: ConfigChoice
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SettingsDTO:
      properties:
        llm:
          $ref: '#/components/schemas/LLMConfigOutputDTO'
        vectorDb:
          $ref: '#/components/schemas/VectorDBConfigOutputDTO'
      type: object
      required:
      - llm
      - vectorDb
      title: SettingsDTO
    SettingsPayloadDTO:
      properties:
        llm:
          anyOf:
          - $ref: '#/components/schemas/LLMConfigInputDTO'
          - type: 'null'
        vectorDb:
          anyOf:
          - $ref: '#/components/schemas/VectorDBConfigInputDTO'
          - type: 'null'
      type: object
      title: SettingsPayloadDTO
    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
    LLMConfigInputDTO:
      properties:
        provider:
          type: string
          enum:
          - openai
          - ollama
          - anthropic
          - gemini
          - mistral
          title: Provider
        model:
          type: string
          title: Model
        apiKey:
          type: string
          title: Apikey
      type: object
      required:
      - provider
      - model
      - apiKey
      title: LLMConfigInputDTO
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    VectorDBConfigInputDTO:
      properties:
        provider:
          type: string
          enum:
          - lancedb
          - pgvector
          title: Provider
        url:
          type: string
          title: Url
        apiKey:
          type: string
          title: Apikey
      type: object
      required:
      - provider
      - url
      - apiKey
      title: VectorDBConfigInputDTO
    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
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    CookieAuth:
      type: apiKey
      in: cookie
      name: auth_token
x-provenance:
  method: harvested
  publisher: Cognee
  source: https://docs.cognee.ai/cognee_openapi_spec.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)