Komga offers a REST API, which you can browse using Swagger. It's available at
The OpenAPI specification is also available here.
Most endpoints require authentication. Authentication is done using Basic Authentication and can be set on any endpoint.
Upon successful authentication, a session is created, and can be reused.
- By default, a
SESSIONcookie is set via
Set-Cookieresponse header. This works well for browsers and clients that can handle cookies.
- If you specify a header
X-Auth-Tokenduring authentication, the session ID will be returned via this same header. You can then pass that header again for subsequent requests to reuse the session.
If you need to set the session cookie later on, you can call
X-Auth-Token. The response will contain the
During authentication, if a request parameter
remember-me is passed and set to
true, the server will also return a
remember-me cookie. This cookie will be used to login automatically even if the session has expired.
You can explicitely logout an existing session by calling
/api/logout. This would return a