Cognee Configuration API

openapi: 3.2.0
info:
  title: Cognee Configuration 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: Configuration
  description: Endpoints for storing, retrieving, and listing a user's saved configurations.
paths:
  /api/v1/configuration/store_user_configuration:
    post:
      tags:
      - Configuration
      summary: Store User Configuration
      description: 'Store (upsert) a named configuration for the authenticated user.


        ## Request Parameters

        - **name** (str): Name of the configuration. If a configuration with the same name

        already exists for this user, it is updated in place.

        - **config** (dict): JSON-serializable configuration data to store (e.g. a KG schema,

        LLM settings, or ingestion parameters).


        ## Response

        Returns null on success (HTTP 200).'
      operationId: store_user_configuration_api_v1_configuration_store_user_configuration_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StorePrincipalConfigurationPayloadDTO'
        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: []
  /api/v1/configuration/get_user_configuration/{config_id}:
    get:
      tags:
      - Configuration
      summary: Get User Configuration
      description: 'Get a stored configuration by its UUID.


        ## Path Parameters

        - **config_id** (UUID): The "id" of a configuration previously returned by

        GET /api/v1/configuration/get_user_configuration/.


        ## Response

        Returns the stored configuration data as a JSON object. The id may name a

        configuration of the authenticated user or of an agent user they are the parent

        of. Returns an empty object \{\} with HTTP 200 (not 404) when neither has a

        configuration with that id, including when the id belongs to another user''s

        configuration.'
      operationId: get_user_configuration_api_v1_configuration_get_user_configuration__config_id__get
      security:
      - BearerAuth: []
      - ApiKeyAuth: []
      parameters:
      - name: config_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: UUID of a stored configuration (the 'id' field returned by GET /api/v1/configuration/get_user_configuration/).
          examples:
          - a1b2c3d4-e5f6-7890-abcd-ef1234567890
          title: Config Id
        description: UUID of a stored configuration (the 'id' field returned by GET /api/v1/configuration/get_user_configuration/).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get User Configuration Api V1 Configuration Get User Configuration  Config Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/configuration/get_user_configuration/:
    get:
      tags:
      - Configuration
      summary: Get User All Configuration
      description: 'List all configurations stored by the authenticated user and by the agent users

        they are the parent of.


        ## Response

        Returns a JSON list of records of the form \{"id", "ownerId", "name", "configuration",

        "createdAt", "updatedAt"\}; "ownerId" tells the user''s own records from an agent''s.

        Returns an empty list when none exist. Use the "id" value with

        GET /api/v1/configuration/get_user_configuration/\{config_id\} to fetch a single

        configuration''s data.'
      operationId: get_user_all_configuration_api_v1_configuration_get_user_configuration__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items: {}
                type: array
                title: Response Get User All Configuration Api V1 Configuration Get User Configuration  Get
      security:
      - BearerAuth: []
      - ApiKeyAuth: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    StorePrincipalConfigurationPayloadDTO:
      properties:
        name:
          type: string
          title: Name
          description: 'Name of the configuration to store. If a configuration with this name already exists for the user it is updated in place. Always provide a value: omitting it results in a server error.'
          examples:
          - default_llm_settings
        config:
          additionalProperties: true
          type: object
          title: Config
          description: 'The configuration data to store as a JSON object (e.g. a KG schema, LLM settings, or ingestion parameters). Always provide a value: omitting it results in a server error.'
          examples:
          - chunk_size: 4096
            llm_model: openai/gpt-4o-mini
      type: object
      title: StorePrincipalConfigurationPayloadDTO
  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)