Keep

Keep Search API

The Search API from Keep — 2 operation(s) for search.

Documentation GitHub OpenAPI

Operations 2

GET /api/search Search Notes and Items together #

GET /api/context/brief Get a bounded recent-Note index for a Git project #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/keep-md/openapi/keep-md-search-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-md:keep-md-search-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Keep Search API
  version: 0.2.0
  description: The stable API for Keep accounts, saved Items, Notes, Projects, sources, exports, and webhooks.
servers:
- url: https://keep.md
  description: Production
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: Search
paths:
  /api/search:
    get:
      tags:
      - Search
      operationId: searchContext
      summary: Search Notes and Items together
      parameters:
      - name: q
        in: query
        description: Search query
        schema:
          type: string
          maxLength: 500
        required: true
      - name: types
        in: query
        description: Comma-separated item and note resource types
        schema:
          type: string
          default: item,note
      - name: mode
        in: query
        schema:
          type: string
          enum:
          - lexical
          - semantic
          - hybrid
          default: hybrid
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      - name: contentBytes
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 200000
          default: 60000
      - name: include
        in: query
        schema:
          type: string
          enum:
          - content
      - name: content
        in: query
        schema:
          type: integer
          enum:
          - 1
      - name: project
        in: query
        schema:
          type: string
      - name: path
        in: query
        schema:
          type: string
      - name: exactProject
        in: query
        schema:
          type: boolean
      - name: exactPath
        in: query
        schema:
          type: boolean
      - name: includeArchived
        in: query
        schema:
          type: boolean
      - name: tags
        in: query
        schema:
          type: string
      - name: kind
        in: query
        schema:
          type: string
      - name: state
        in: query
        schema:
          type: string
      - $ref: '#/components/parameters/Since'
      - $ref: '#/components/parameters/Until'
      - $ref: '#/components/parameters/Keep-API-Version'
      responses:
        '200':
          description: Mixed search results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeepSearchResponse'
          headers:
            Keep-API-Version:
              $ref: '#/components/headers/Keep-API-Version'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            Sunset:
              $ref: '#/components/headers/Sunset'
            Link:
              $ref: '#/components/headers/Link'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Keep-API-Version:
              $ref: '#/components/headers/Keep-API-Version'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            Sunset:
              $ref: '#/components/headers/Sunset'
            Link:
              $ref: '#/components/headers/Link'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Keep-API-Version:
              $ref: '#/components/headers/Keep-API-Version'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            Sunset:
              $ref: '#/components/headers/Sunset'
            Link:
              $ref: '#/components/headers/Link'
        '403':
          description: The credential lacks access or the plan does not include the feature
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Keep-API-Version:
              $ref: '#/components/headers/Keep-API-Version'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            Sunset:
              $ref: '#/components/headers/Sunset'
            Link:
              $ref: '#/components/headers/Link'
      description: Search Notes and Items together.
  /api/context/brief:
    get:
      tags:
      - Search
      operationId: getContextBrief
      summary: Get a bounded recent-Note index for a Git project
      parameters:
      - name: project
        in: query
        schema:
          type: string
        required: true
      - name: path
        in: query
        schema:
          type: string
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 20
      - $ref: '#/components/parameters/Keep-API-Version'
      responses:
        '200':
          description: Project Note index without Note bodies
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
          headers:
            Keep-API-Version:
              $ref: '#/components/headers/Keep-API-Version'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            Sunset:
              $ref: '#/components/headers/Sunset'
            Link:
              $ref: '#/components/headers/Link'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Keep-API-Version:
              $ref: '#/components/headers/Keep-API-Version'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            Sunset:
              $ref: '#/components/headers/Sunset'
            Link:
              $ref: '#/components/headers/Link'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Keep-API-Version:
              $ref: '#/components/headers/Keep-API-Version'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            Sunset:
              $ref: '#/components/headers/Sunset'
            Link:
              $ref: '#/components/headers/Link'
        '403':
          description: The credential lacks access or the plan does not include the feature
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Keep-API-Version:
              $ref: '#/components/headers/Keep-API-Version'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            Sunset:
              $ref: '#/components/headers/Sunset'
            Link:
              $ref: '#/components/headers/Link'
      description: Get a bounded recent-Note index for a Git project.
components:
  headers:
    Keep-API-Version:
      description: The date-based version used for this response.
      schema:
        type: string
        example: '2026-08-24'
    Retry-After:
      description: Seconds to wait before another request.
      schema:
        type: integer
        example: 60
    RateLimit-Policy:
      description: The request quota and time window for the active policy.
      schema:
        type: string
        example: '"api";q=300;w=60'
    RateLimit:
      description: The remaining quota and reset time. It is returned when a limit is reached.
      schema:
        type: string
        example: '"api";r=0;t=60'
    Link:
      description: A link to migration information for a deprecated version.
      schema:
        type: string
    Sunset:
      description: The date after which a deprecated API version stops working.
      schema:
        type: string
        format: http-date
    Deprecation:
      description: The Structured Field date when the selected API version became deprecated.
      schema:
        type: string
        example: '@1819756800'
  schemas:
    KeepSearchResult:
      type: object
      required:
      - resource
      - title
      - snippet
      - matchKind
      properties:
        resource:
          type: object
          required:
          - type
          - id
          properties:
            type:
              type: string
              enum:
              - item
              - note
            id:
              type: string
          additionalProperties: false
        title:
          type: string
          maxLength: 600
        snippet:
          type: string
          description: At most 600 UTF-8 bytes.
        snippetTruncated:
          type: boolean
        matchKind:
          type: string
          enum:
          - title
          - body
          - summary
          - highlight
          - metadata
        revision:
          type: integer
          minimum: 1
        range:
          type: object
          required:
          - startLine
          - endLine
          properties:
            startLine:
              type: integer
              minimum: 1
            endLine:
              type: integer
              minimum: 1
          additionalProperties: false
        details:
          type: object
          additionalProperties: true
        content:
          type: string
        contentTruncated:
          type: boolean
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: string
        message:
          type: string
        limit:
          type: integer
        resolution:
          type: string
          description: A suggested action that can resolve the error.
      additionalProperties: true
    KeepSearchResponse:
      type: object
      required:
      - query
      - mode
      - results
      - semantic
      properties:
        query:
          type: string
          maxLength: 500
        mode:
          type: string
          enum:
          - lexical
          - semantic
          - hybrid
        results:
          type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/KeepSearchResult'
        semantic:
          type: object
          required:
          - status
          - available
          - used
          - lexicalOnlyCount
          properties:
            status:
              type: string
            available:
              type: boolean
            used:
              type: boolean
            lexicalOnlyCount:
              type: integer
              minimum: 0
          additionalProperties: false
      additionalProperties: false
  parameters:
    Keep-API-Version:
      name: Keep-API-Version
      in: header
      required: false
      description: Optional date-based Keep API version. Omit it to use the current version.
      schema:
        type: string
        example: '2026-08-24'
    Since:
      name: since
      in: query
      description: Unix timestamp or ISO date
      schema:
        oneOf:
        - type: integer
        - type: string
          format: date-time
    Until:
      name: until
      in: query
      description: Unix timestamp or ISO date
      schema:
        oneOf:
        - type: integer
        - type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Keep API key
      description: A personal Keep API key.
    sessionCookie:
      type: apiKey
      in: cookie
      name: keep.session_token
      description: The authenticated Keep web session. Token management requires this session.
x-api-version-header: Keep-API-Version
x-current-api-version: '2026-08-24'
x-versioning-policy:
  strategy: date-based request header
  default: The current version is used when the header is omitted.
  deprecation: Deprecated versions remain available for at least six months and return Deprecation, Sunset, and Link headers.