Laravel Laravel
  • Prologue

    • Release Notes
  • Getting Started

    • Installation
    • Configuration
    • Docker
    • Update
    • Upgrade from v3
  • Advanced Topics

    • Settings
    • Keyboard Shortcuts
    • Advanced Setups
    • Honeypot and Teapots
    • External tracking with Matomo,
      Google Analytics & Co
  • Frequently Asked Question

    • General
    • Installation, migration, upgrade, update
    • Troubleshooting
  • Contributing

    • Contribution Guide
    • API Documentation
    • Lychee logic overview
    • Directory Structure
    • Front-end
  • Laravel

API Documentation


    The current API provide the following entry points: See:

    • routes/api_v2.php
    • routes/web-admin-v2.php
    • routes/web_v2.php

    Note that for all request, 'Accept: application/json' is mandatory and that without mention of the contrary 'Content-Type: application/json' is also mandatory.

    As of version 4.8.1, the api documentation is moved directly inside your own Lychee instance. It is accessible at the url https://yourLycheeInstance.org/docs/api. It is also possible to see it on our demo website: https://lychee-demo.fly.dev/docs/api

    {tip} Caught a mistake or want to contribute to the documentation? Edit this page on Github!