Keep

Keep settings API

The settings API from Keep — 7 operation(s) for settings.

GitHub OpenAPI

Operations 10

GET /settings/webhook Webhook Settings #
GET /settings/smtp Get Smtp Settings #
POST /settings/smtp Update Smtp Settings #
DELETE /settings/smtp Delete Smtp Settings #
POST /settings/smtp/test Test Smtp Settings #
PUT /settings/apikey Update Api Key #
POST /settings/apikey Create Key #
GET /settings/apikeys Get Keys #
DELETE /settings/apikey/{keyId} Delete Api Key #
GET /settings/sso Get Sso Settings #

Documentation

📖
Documentation
https://docs.keephq.dev/overview/introduction
📖
APIReference
https://api.keephq.dev/docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/keep/refs/heads/main/openapi/keep-settings-api-openapi.yml

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/keep-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

keep-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Keep actions Settings API
  description: Rest API powering https://platform.keephq.dev and friends 🏄‍♀️
  version: 0.24.5
servers:
- url: https://api.keephq.dev
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: settings
paths:
  /settings/webhook:
    get:
      tags:
      - settings
      summary: Webhook Settings
      description: Get details about the webhook endpoint (e.g. the API url and an API key)
      operationId: webhook_settings_settings_webhook_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSettings'
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
  /settings/smtp:
    get:
      tags:
      - settings
      summary: Get Smtp Settings
      description: Get SMTP settings
      operationId: get_smtp_settings_settings_smtp_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
    post:
      tags:
      - settings
      summary: Update Smtp Settings
      description: Install or update SMTP settings
      operationId: update_smtp_settings_settings_smtp_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SMTPSettings'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
    delete:
      tags:
      - settings
      summary: Delete Smtp Settings
      description: Delete SMTP settings
      operationId: delete_smtp_settings_settings_smtp_delete
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
  /settings/smtp/test:
    post:
      tags:
      - settings
      summary: Test Smtp Settings
      description: Test SMTP settings
      operationId: test_smtp_settings_settings_smtp_test_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SMTPSettings'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
  /settings/apikey:
    put:
      tags:
      - settings
      summary: Update Api Key
      description: Update API key secret
      operationId: update_api_key_settings_apikey_put
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
    post:
      tags:
      - settings
      summary: Create Key
      description: Create API key
      operationId: create_key_settings_apikey_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
  /settings/apikeys:
    get:
      tags:
      - settings
      summary: Get Keys
      description: Get API keys
      operationId: get_keys_settings_apikeys_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
  /settings/apikey/{keyId}:
    delete:
      tags:
      - settings
      summary: Delete Api Key
      description: Delete API key
      operationId: delete_api_key_settings_apikey__keyId__delete
      parameters:
      - required: true
        schema:
          type: string
          title: Keyid
        name: keyId
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
  /settings/sso:
    get:
      tags:
      - settings
      summary: Get Sso Settings
      operationId: get_sso_settings_settings_sso_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
components:
  schemas:
    WebhookSettings:
      properties:
        webhookApi:
          type: string
          title: Webhookapi
        apiKey:
          type: string
          title: Apikey
        modelSchema:
          type: object
          title: Modelschema
      type: object
      required:
      - webhookApi
      - apiKey
      - modelSchema
      title: WebhookSettings
    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
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    SMTPSettings:
      properties:
        host:
          type: string
          title: Host
        port:
          type: integer
          title: Port
        from_email:
          type: string
          title: From Email
        username:
          type: string
          title: Username
        password:
          type: string
          format: password
          title: Password
          writeOnly: true
        secure:
          type: boolean
          title: Secure
          default: true
        to_email:
          type: string
          title: To Email
          default: keep@example.com
      type: object
      required:
      - host
      - port
      - from_email
      title: SMTPSettings
      example:
        host: smtp.example.com
        port: 587
        username: user@example.com
        password: password
        secure: true
        from_email: noreply@example.com
        to_email: ''
  securitySchemes:
    API_Key:
      type: apiKey
      in: header
      name: X-API-KEY
    HTTPBasic:
      type: http
      scheme: basic
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: token