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-highlights-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 Highlights 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: Highlights
paths:
  /api/items/{id}/highlights:
    parameters:
    - $ref: '#/components/parameters/ItemId'
    get:
      tags:
      - Highlights
      operationId: listItemHighlights
      summary: List highlights for an Item
      parameters:
      - name: limit
        in: query
        description: Opt into a bounded page
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 25
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
      - $ref: '#/components/parameters/Keep-API-Version'
      responses:
        '200':
          description: Highlights
          content:
            application/json:
              schema:
                type: object
                required:
                - highlights
                properties:
                  highlights:
                    type: array
                    items:
                      $ref: '#/components/schemas/Highlight'
                  limit:
                    type: integer
                  offset:
                    type: integer
                  count:
                    type: integer
                  hasMore:
                    type: boolean
                  nextOffset:
                    type: integer
                  contentTruncated:
                    type: boolean
          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'
        '404':
          description: Resource not found
          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: List highlights for an Item.
    post:
      tags:
      - Highlights
      operationId: createHighlight
      summary: Create a highlight on an Item
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - text
              properties:
                text:
                  type: string
                prefix:
                  type: string
                suffix:
                  type: string
                note:
                  type: string
                startOffset:
                  type: integer
                endOffset:
                  type: integer
              additionalProperties: false
      responses:
        '201':
          description: Created highlight
          content:
            application/json:
              schema:
                type: object
                required:
                - highlight
                properties:
                  highlight:
                    $ref: '#/components/schemas/Highlight'
          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'
        '404':
          description: Resource not found
          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: Create a highlight on an Item.
      parameters:
      - $ref: '#/components/parameters/Keep-API-Version'
  /api/highlights/{id}:
    parameters:
    - $ref: '#/components/parameters/HighlightId'
    get:
      tags:
      - Highlights
      operationId: getHighlight
      summary: Get one highlight
      responses:
        '200':
          description: Highlight
          content:
            application/json:
              schema:
                type: object
                required:
                - highlight
                properties:
                  highlight:
                    $ref: '#/components/schemas/Highlight'
          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'
        '404':
          description: Resource not found
          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 one highlight.
      parameters:
      - $ref: '#/components/parameters/Keep-API-Version'
    patch:
      tags:
      - Highlights
      operationId: updateHighlight
      summary: Update highlight text, anchors, offsets, or note
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                prefix:
                  type: string
                suffix:
                  type: string
                note:
                  type:
                  - string
                  - 'null'
                startOffset:
                  type: integer
                endOffset:
                  type: integer
              additionalProperties: false
      responses:
        '200':
          description: Updated highlight
          content:
            application/json:
              schema:
                type: object
                required:
                - highlight
                properties:
                  highlight:
                    $ref: '#/components/schemas/Highlight'
          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'
        '404':
          description: Resource not found
          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: Update highlight text, anchors, offsets, or note.
      parameters:
      - $ref: '#/components/parameters/Keep-API-Version'
    delete:
      tags:
      - Highlights
      operationId: deleteHighlight
      summary: Permanently delete a highlight
      responses:
        '200':
          description: Deleted highlight
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OkResponse'
          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'
        '404':
          description: Resource not found
          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: Permanently delete a highlight.
      parameters:
      - $ref: '#/components/parameters/Keep-API-Version'
components:
  headers:
    Keep-API-Version:
      description: The date-based version used for this response.
      schema:
        type: string
        example: '2026-08-24'
    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
    Retry-After:
      description: Seconds to wait before another request.
      schema:
        type: integer
        example: 60
    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:
    Highlight:
      type: object
      required:
      - id
      - itemId
      - text
      - createdAt
      - updatedAt
      properties:
        id:
          type: string
        itemId:
          type: string
        text:
          type: string
        prefix:
          type: string
        suffix:
          type: string
        note:
          type:
          - string
          - 'null'
        startOffset:
          type: integer
        endOffset:
          type: integer
        createdAt:
          type: integer
        updatedAt:
          type: integer
      additionalProperties: true
    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
    OkResponse:
      type: object
      required:
      - ok
      properties:
        ok:
          type: boolean
      additionalProperties: true
  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'
    HighlightId:
      name: id
      in: path
      required: true
      description: Highlight ID
      schema:
        type: string
    ItemId:
      name: id
      in: path
      required: true
      description: Saved Item ID
      schema:
        type: string
  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.