Linkwarden

Linkwarden Highlights API

The Highlights API from Linkwarden — 2 operation(s) for highlights.

Documentation GitHub OpenAPI

Operations 2

POST /api/v1/highlights Create or update a highlight #

DELETE /api/v1/highlights/{id} Delete a highlight #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/linkwarden/openapi/linkwarden-highlights-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/linkwarden:linkwarden-highlights-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

openapi: 3.2.0
info:
  description: Linkwarden OpenAPI Documentation.
  version: 1.0.0
  title: Introduction Highlights API
  license:
    name: GNU Affero General Public License v3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
tags:
- name: Highlights
paths:
  /api/v1/highlights:
    post:
      security:
      - bearerAuth: []
      tags:
      - Highlights
      summary: Create or update a highlight
      description: Creates a new highlight for the authenticated user, or updates an existing one matching the same offsets on the same link.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - color
              - startOffset
              - endOffset
              - text
              - linkId
              properties:
                color:
                  type: string
                  maxLength: 50
                comment:
                  type:
                  - string
                  - 'null'
                  maxLength: 2048
                startOffset:
                  type: integer
                endOffset:
                  type: integer
                text:
                  type: string
                  maxLength: 2048
                linkId:
                  type: integer
      responses:
        '200':
          description: Highlight saved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: object
                    properties:
                      id:
                        type: integer
                      userId:
                        type: integer
                      linkId:
                        type: integer
                      color:
                        type: string
                      comment:
                        type:
                        - string
                        - 'null'
                      startOffset:
                        type: integer
                      endOffset:
                        type: integer
                      text:
                        type: string
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      operationId: postApiV1Highlights
      x-operation-id-source: derived
  /api/v1/highlights/{id}:
    delete:
      security:
      - bearerAuth: []
      tags:
      - Highlights
      summary: Delete a highlight
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the highlight to delete.
        schema:
          type: integer
      responses:
        '200':
          description: Highlight deleted successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: integer
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      operationId: deleteApiV1HighlightsById
      x-operation-id-source: derived
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        response:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT