Kavita Upload API

The Upload API from Kavita — 13 operation(s) for upload.

GitHub OpenAPI

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/Upload/upload-by-url Upload an image from a URL for covers · This stores a file (image) in temp directory for use in a cover image… #
Ask an LLM
“How do I upload a cover image from a URL for a series or chapter?”
“Can I stage an image from a web link to use as a cover?”
Tell an agent
Upload the image at {url} for a cover.
Stage {url} as a cover image.
POST /api/Upload/upload-chapter-cover Upload a chapter cover image · Create api upload upload chapter cover #
Ask an LLM
“How do I set a cover image for a single chapter?”
“Can I upload a chapter cover by chapter ID?”
Tell an agent
Upload a chapter cover for chapter {chapterId}.
Set a cover image on chapter {chapterId}.
POST /api/Upload/upload-volume-cover Upload a volume cover image · Create api upload upload volume cover #
Ask an LLM
“How do I upload a cover for a volume?”
“Can I replace a volume's cover image by volume ID?”
Tell an agent
Upload a volume cover for volume {volumeId}.
Set a cover image on volume {volumeId}.
POST /api/Upload/upload-series-cover Upload a series cover image · Create api upload upload series cover #
Ask an LLM
“How do I upload a cover image for a series?”
“Can I replace a series cover by series ID?”
Tell an agent
Upload a series cover for series {seriesId}.
Set a cover image on series {seriesId}.
POST /api/Upload/upload-by-file Upload an image file for covers · Stages an uploaded image file in the temp directory for use in a cover image… #
Ask an LLM
“How do I upload a cover image from a file on my computer?”
“Can I stage an image file to use as a cover?”
Tell an agent
Upload {file} as a cover image.
Stage this image file for a cover.
POST /api/Upload/series Replace a series cover with a base64 image · Replaces series cover image and locks it with a base64 encoded image #
Ask an LLM
“How do I replace a series cover with a base64-encoded image?”
“Can I lock a series cover once uploaded?”
Tell an agent
Replace series {id}'s cover with {url}.
Set series {id}'s cover to {url} and lock it ({lockCover}).
POST /api/Upload/collection Replace a collection cover with a base64 image · Replaces collection tag cover image and locks it with a base64 encoded image #
Ask an LLM
“How do I replace a collection's cover image?”
“Can I lock a collection cover after uploading it?”
Tell an agent
Replace collection {id}'s cover with {url}.
Set collection {id}'s cover to {url} and lock it ({lockCover}).
POST /api/Upload/reading-list Replace a reading list cover · Replaces reading list cover image and locks it with a base64 encoded image #
Ask an LLM
“How do I upload a cover image for a reading list?”
“Can a non-admin replace a reading list cover?”
Tell an agent
Replace reading list {id}'s cover with {url}.
Set reading list {id}'s cover to {url} and lock it ({lockCover}).
POST /api/Upload/chapter Replace a chapter cover with a base64 image · Replaces chapter cover image and locks it with a base64 encoded image. #
Ask an LLM
“How do I replace a chapter's cover image?”
“Can I lock a chapter cover after uploading it?”
Tell an agent
Replace chapter {id}'s cover with {url}.
Set chapter {id}'s cover to {url} and lock it ({lockCover}).
POST /api/Upload/volume Replace a volume cover with a base64 image · Replaces volume cover image and locks it with a base64 encoded image #
Ask an LLM
“How do I replace a volume's cover image?”
“Does replacing a volume cover update the chapters inside?”
Tell an agent
Replace volume {id}'s cover with {url}.
Set volume {id}'s cover to {url} and lock it ({lockCover}).
POST /api/Upload/library Replace a library cover with a base64 image · Replaces library cover image with a base64 encoded image. #
Ask an LLM
“How do I upload a cover image for a library?”
“Can I lock a library cover once uploaded?”
Tell an agent
Replace library {id}'s cover with {url}.
Set library {id}'s cover to {url} and lock it ({lockCover}).
POST /api/Upload/person Replace a person tag cover with a base64 image · Replaces person tag cover image and locks it with a base64 encoded image #
Ask an LLM
“How do I upload a cover image for a person tag?”
“Can I lock a person tag cover after uploading it?”
Tell an agent
Replace person {id}'s cover with {url}.
Set person {id}'s cover to {url} and lock it ({lockCover}).
POST /api/Upload/user Replace a user cover image · Replaces user cover image and locks it with a base64 encoded image #
Ask an LLM
“How do I upload a cover image for my own user profile?”
“Do I have to be the user to replace their cover?”
Tell an agent
Replace user {id}'s cover with {url}.
Set user {id}'s cover to {url} and lock it ({lockCover}).

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/kavita:kavita-upload-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

kavita-upload-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Kavita Upload API
  description: Kavita provides a set of APIs authenticated via an Auth Key passed in the `x-api-key` header. Generate an Auth Key under User Settings → Manage Auth Keys, paste it into the Authorize panel, and all Try It requests will include it. Assume all fields of a payload are required unless marked optional. Built against v0.9.1.15
  license:
    name: GPL-3.0
    url: https://github.com/Kareadita/Kavita/blob/develop/LICENSE
  version: 0.9.1.15
servers:
- url: '{protocol}://{hostpath}'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    hostpath:
      default: localhost:5000
security:
- AuthKey: []
tags:
- name: Upload
paths:
  /api/Upload/upload-by-url:
    post:
      tags:
      - Upload
      summary: This stores a file (image) in temp directory for use in a cover image…
      requestBody:
        description: Escaped url to download from
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadUrlDto'
          text/json:
            schema:
              $ref: '#/components/schemas/UploadUrlDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UploadUrlDto'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      operationId: postApiUploadUploadByUrl
      x-operation-id-source: derived
  /api/Upload/upload-chapter-cover:
    post:
      tags:
      - Upload
      parameters:
      - name: chapterId
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      summary: Create api upload upload chapter cover
      x-summary-source: derived
      operationId: postApiUploadUploadChapterCover
      x-operation-id-source: derived
  /api/Upload/upload-volume-cover:
    post:
      tags:
      - Upload
      parameters:
      - name: volumeId
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      summary: Create api upload upload volume cover
      x-summary-source: derived
      operationId: postApiUploadUploadVolumeCover
      x-operation-id-source: derived
  /api/Upload/upload-series-cover:
    post:
      tags:
      - Upload
      parameters:
      - name: seriesId
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      summary: Create api upload upload series cover
      x-summary-source: derived
      operationId: postApiUploadUploadSeriesCover
      x-operation-id-source: derived
  /api/Upload/upload-by-file:
    post:
      tags:
      - Upload
      summary: Stages an uploaded image file in the temp directory for use in a cover image…
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: The image file to stage
                  format: binary
            encoding:
              file:
                style: form
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      operationId: postApiUploadUploadByFile
      x-operation-id-source: derived
  /api/Upload/series:
    post:
      tags:
      - Upload
      summary: Replaces series cover image and locks it with a base64 encoded image
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          text/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
      responses:
        '200':
          description: OK
      operationId: postApiUploadSeries
      x-operation-id-source: derived
  /api/Upload/collection:
    post:
      tags:
      - Upload
      summary: Replaces collection tag cover image and locks it with a base64 encoded image
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          text/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
      responses:
        '200':
          description: OK
      operationId: postApiUploadCollection
      x-operation-id-source: derived
  /api/Upload/reading-list:
    post:
      tags:
      - Upload
      summary: Replaces reading list cover image and locks it with a base64 encoded image
      description: This is the only API that can be called by non-admins, but the authenticated user must have a readinglist permission
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          text/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
      responses:
        '200':
          description: OK
      operationId: postApiUploadReadingList
      x-operation-id-source: derived
  /api/Upload/chapter:
    post:
      tags:
      - Upload
      summary: Replaces chapter cover image and locks it with a base64 encoded image.
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          text/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
      responses:
        '200':
          description: OK
      operationId: postApiUploadChapter
      x-operation-id-source: derived
  /api/Upload/volume:
    post:
      tags:
      - Upload
      summary: Replaces volume cover image and locks it with a base64 encoded image
      description: This will not update the underlying chapter
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          text/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
      responses:
        '200':
          description: OK
      operationId: postApiUploadVolume
      x-operation-id-source: derived
  /api/Upload/library:
    post:
      tags:
      - Upload
      summary: Replaces library cover image with a base64 encoded image.
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          text/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
      responses:
        '200':
          description: OK
      operationId: postApiUploadLibrary
      x-operation-id-source: derived
  /api/Upload/person:
    post:
      tags:
      - Upload
      summary: Replaces person tag cover image and locks it with a base64 encoded image
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          text/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
      responses:
        '200':
          description: OK
      operationId: postApiUploadPerson
      x-operation-id-source: derived
  /api/Upload/user:
    post:
      tags:
      - Upload
      summary: Replaces user cover image and locks it with a base64 encoded image
      description: You MUST be the user in question
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          text/json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UploadCoverFileDto'
      responses:
        '200':
          description: OK
      operationId: postApiUploadUser
      x-operation-id-source: derived
components:
  schemas:
    UploadCoverFileDto:
      required:
      - id
      type: object
      properties:
        id:
          type: integer
          format: int32
        url:
          type:
          - string
          - 'null'
        fileName:
          type:
          - string
          - 'null'
        lockCover:
          type: boolean
      additionalProperties: false
    UploadUrlDto:
      required:
      - url
      type: object
      properties:
        url:
          minLength: 1
          type: string
      additionalProperties: false
  securitySchemes:
    AuthKey:
      type: apiKey
      description: Auth Key authentication. Enter your Auth key from your user settings
      name: x-api-key
      in: header