Update book metadata
curl --request PATCH \
--url https://demo.komga.org/api/v1/books/{bookId}/metadata \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"authors": [
{
"name": "<string>",
"role": "<string>"
}
],
"authorsLock": true,
"isbn": "<string>",
"isbnLock": true,
"links": [
{
"label": "<string>",
"url": "<string>"
}
],
"linksLock": true,
"number": "<string>",
"numberLock": true,
"numberSort": 123,
"numberSortLock": true,
"releaseDate": "2023-12-25",
"releaseDateLock": true,
"summary": "<string>",
"summaryLock": true,
"tags": [
"<string>"
],
"tagsLock": true,
"title": "<string>",
"titleLock": true
}
'import requests
url = "https://demo.komga.org/api/v1/books/{bookId}/metadata"
payload = {
"authors": [
{
"name": "<string>",
"role": "<string>"
}
],
"authorsLock": True,
"isbn": "<string>",
"isbnLock": True,
"links": [
{
"label": "<string>",
"url": "<string>"
}
],
"linksLock": True,
"number": "<string>",
"numberLock": True,
"numberSort": 123,
"numberSortLock": True,
"releaseDate": "2023-12-25",
"releaseDateLock": True,
"summary": "<string>",
"summaryLock": True,
"tags": ["<string>"],
"tagsLock": True,
"title": "<string>",
"titleLock": True
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authors: [{name: '<string>', role: '<string>'}],
authorsLock: true,
isbn: '<string>',
isbnLock: true,
links: [{label: '<string>', url: '<string>'}],
linksLock: true,
number: '<string>',
numberLock: true,
numberSort: 123,
numberSortLock: true,
releaseDate: '2023-12-25',
releaseDateLock: true,
summary: '<string>',
summaryLock: true,
tags: ['<string>'],
tagsLock: true,
title: '<string>',
titleLock: true
})
};
fetch('https://demo.komga.org/api/v1/books/{bookId}/metadata', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://demo.komga.org/api/v1/books/{bookId}/metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'authors' => [
[
'name' => '<string>',
'role' => '<string>'
]
],
'authorsLock' => true,
'isbn' => '<string>',
'isbnLock' => true,
'links' => [
[
'label' => '<string>',
'url' => '<string>'
]
],
'linksLock' => true,
'number' => '<string>',
'numberLock' => true,
'numberSort' => 123,
'numberSortLock' => true,
'releaseDate' => '2023-12-25',
'releaseDateLock' => true,
'summary' => '<string>',
'summaryLock' => true,
'tags' => [
'<string>'
],
'tagsLock' => true,
'title' => '<string>',
'titleLock' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://demo.komga.org/api/v1/books/{bookId}/metadata"
payload := strings.NewReader("{\n \"authors\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"authorsLock\": true,\n \"isbn\": \"<string>\",\n \"isbnLock\": true,\n \"links\": [\n {\n \"label\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"linksLock\": true,\n \"number\": \"<string>\",\n \"numberLock\": true,\n \"numberSort\": 123,\n \"numberSortLock\": true,\n \"releaseDate\": \"2023-12-25\",\n \"releaseDateLock\": true,\n \"summary\": \"<string>\",\n \"summaryLock\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"tagsLock\": true,\n \"title\": \"<string>\",\n \"titleLock\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://demo.komga.org/api/v1/books/{bookId}/metadata")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"authors\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"authorsLock\": true,\n \"isbn\": \"<string>\",\n \"isbnLock\": true,\n \"links\": [\n {\n \"label\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"linksLock\": true,\n \"number\": \"<string>\",\n \"numberLock\": true,\n \"numberSort\": 123,\n \"numberSortLock\": true,\n \"releaseDate\": \"2023-12-25\",\n \"releaseDateLock\": true,\n \"summary\": \"<string>\",\n \"summaryLock\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"tagsLock\": true,\n \"title\": \"<string>\",\n \"titleLock\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://demo.komga.org/api/v1/books/{bookId}/metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"authors\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"authorsLock\": true,\n \"isbn\": \"<string>\",\n \"isbnLock\": true,\n \"links\": [\n {\n \"label\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"linksLock\": true,\n \"number\": \"<string>\",\n \"numberLock\": true,\n \"numberSort\": 123,\n \"numberSortLock\": true,\n \"releaseDate\": \"2023-12-25\",\n \"releaseDateLock\": true,\n \"summary\": \"<string>\",\n \"summaryLock\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"tagsLock\": true,\n \"title\": \"<string>\",\n \"titleLock\": true\n}"
response = http.request(request)
puts response.read_body{
"violations": [
{
"fieldName": "<string>",
"message": "<string>"
}
]
}Books
Update book metadata
Set a field to null to unset the metadata. You can omit fields you don’t want to update.
Required role: ADMIN
PATCH
/
api
/
v1
/
books
/
{bookId}
/
metadata
Update book metadata
curl --request PATCH \
--url https://demo.komga.org/api/v1/books/{bookId}/metadata \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"authors": [
{
"name": "<string>",
"role": "<string>"
}
],
"authorsLock": true,
"isbn": "<string>",
"isbnLock": true,
"links": [
{
"label": "<string>",
"url": "<string>"
}
],
"linksLock": true,
"number": "<string>",
"numberLock": true,
"numberSort": 123,
"numberSortLock": true,
"releaseDate": "2023-12-25",
"releaseDateLock": true,
"summary": "<string>",
"summaryLock": true,
"tags": [
"<string>"
],
"tagsLock": true,
"title": "<string>",
"titleLock": true
}
'import requests
url = "https://demo.komga.org/api/v1/books/{bookId}/metadata"
payload = {
"authors": [
{
"name": "<string>",
"role": "<string>"
}
],
"authorsLock": True,
"isbn": "<string>",
"isbnLock": True,
"links": [
{
"label": "<string>",
"url": "<string>"
}
],
"linksLock": True,
"number": "<string>",
"numberLock": True,
"numberSort": 123,
"numberSortLock": True,
"releaseDate": "2023-12-25",
"releaseDateLock": True,
"summary": "<string>",
"summaryLock": True,
"tags": ["<string>"],
"tagsLock": True,
"title": "<string>",
"titleLock": True
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authors: [{name: '<string>', role: '<string>'}],
authorsLock: true,
isbn: '<string>',
isbnLock: true,
links: [{label: '<string>', url: '<string>'}],
linksLock: true,
number: '<string>',
numberLock: true,
numberSort: 123,
numberSortLock: true,
releaseDate: '2023-12-25',
releaseDateLock: true,
summary: '<string>',
summaryLock: true,
tags: ['<string>'],
tagsLock: true,
title: '<string>',
titleLock: true
})
};
fetch('https://demo.komga.org/api/v1/books/{bookId}/metadata', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://demo.komga.org/api/v1/books/{bookId}/metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'authors' => [
[
'name' => '<string>',
'role' => '<string>'
]
],
'authorsLock' => true,
'isbn' => '<string>',
'isbnLock' => true,
'links' => [
[
'label' => '<string>',
'url' => '<string>'
]
],
'linksLock' => true,
'number' => '<string>',
'numberLock' => true,
'numberSort' => 123,
'numberSortLock' => true,
'releaseDate' => '2023-12-25',
'releaseDateLock' => true,
'summary' => '<string>',
'summaryLock' => true,
'tags' => [
'<string>'
],
'tagsLock' => true,
'title' => '<string>',
'titleLock' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://demo.komga.org/api/v1/books/{bookId}/metadata"
payload := strings.NewReader("{\n \"authors\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"authorsLock\": true,\n \"isbn\": \"<string>\",\n \"isbnLock\": true,\n \"links\": [\n {\n \"label\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"linksLock\": true,\n \"number\": \"<string>\",\n \"numberLock\": true,\n \"numberSort\": 123,\n \"numberSortLock\": true,\n \"releaseDate\": \"2023-12-25\",\n \"releaseDateLock\": true,\n \"summary\": \"<string>\",\n \"summaryLock\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"tagsLock\": true,\n \"title\": \"<string>\",\n \"titleLock\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://demo.komga.org/api/v1/books/{bookId}/metadata")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"authors\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"authorsLock\": true,\n \"isbn\": \"<string>\",\n \"isbnLock\": true,\n \"links\": [\n {\n \"label\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"linksLock\": true,\n \"number\": \"<string>\",\n \"numberLock\": true,\n \"numberSort\": 123,\n \"numberSortLock\": true,\n \"releaseDate\": \"2023-12-25\",\n \"releaseDateLock\": true,\n \"summary\": \"<string>\",\n \"summaryLock\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"tagsLock\": true,\n \"title\": \"<string>\",\n \"titleLock\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://demo.komga.org/api/v1/books/{bookId}/metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"authors\": [\n {\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ],\n \"authorsLock\": true,\n \"isbn\": \"<string>\",\n \"isbnLock\": true,\n \"links\": [\n {\n \"label\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"linksLock\": true,\n \"number\": \"<string>\",\n \"numberLock\": true,\n \"numberSort\": 123,\n \"numberSortLock\": true,\n \"releaseDate\": \"2023-12-25\",\n \"releaseDateLock\": true,\n \"summary\": \"<string>\",\n \"summaryLock\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"tagsLock\": true,\n \"title\": \"<string>\",\n \"titleLock\": true\n}"
response = http.request(request)
puts response.read_body{
"violations": [
{
"fieldName": "<string>",
"message": "<string>"
}
]
}Authorizations
basicAuthapiKey
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
Body
application/json
Metadata fields to update. Set a field to null to unset the metadata. You can omit fields you don't want to update.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
No Content