Write bookmarks
POST
/v1/pdf/bookmarks/write
curl -H "X-Api-Key: $KEY" -F files=@a.pdf -F 'bookmarks=<bookmarks.json' \ http://localhost:9027/v1/pdf/bookmarks/write -o marked.pdfimport { openAsBlob } from 'node:fs';import { readFile, writeFile } from 'node:fs/promises';
const form = new FormData();form.append('files', await openAsBlob('a.pdf'), 'a.pdf');form.append('bookmarks', await readFile('bookmarks.json', 'utf8'));
const response = await fetch('http://localhost:9027/v1/pdf/bookmarks/write', { method: 'POST', headers: { 'X-Api-Key': process.env.KEY }, body: form,});if (!response.ok) throw new Error(await response.text());await writeFile('marked.pdf', Buffer.from(await response.arrayBuffer()));import osfrom pathlib import Path
import requests
response = requests.post( "http://localhost:9027/v1/pdf/bookmarks/write", headers={"X-Api-Key": os.environ["KEY"]}, files=[("files", open("a.pdf", "rb"))], data={"bookmarks": Path("bookmarks.json").read_text()},)response.raise_for_status()Path("marked.pdf").write_bytes(response.content)package main
import ( "bytes" "io" "log" "mime/multipart" "net/http" "os" "path/filepath")
func main() { var body bytes.Buffer form := multipart.NewWriter(&body) attach(form, "files", "a.pdf") bookmarks, err := os.ReadFile("bookmarks.json") if err != nil { log.Fatal(err) } form.WriteField("bookmarks", string(bookmarks)) form.Close()
request, err := http.NewRequest("POST", "http://localhost:9027/v1/pdf/bookmarks/write", &body) if err != nil { log.Fatal(err) } request.Header.Set("X-Api-Key", os.Getenv("KEY")) request.Header.Set("Content-Type", form.FormDataContentType())
response, err := http.DefaultClient.Do(request) if err != nil { log.Fatal(err) } defer response.Body.Close() if response.StatusCode >= 300 { message, _ := io.ReadAll(response.Body) log.Fatalf("%s: %s", response.Status, message) }
out, err := os.Create("marked.pdf") if err != nil { log.Fatal(err) } defer out.Close() if _, err := io.Copy(out, response.Body); err != nil { log.Fatal(err) }}
// attach adds the file at path to the form as the named field.func attach(form *multipart.Writer, field, path string) { file, err := os.Open(path) if err != nil { log.Fatal(err) } defer file.Close() part, err := form.CreateFormFile(field, filepath.Base(path)) if err != nil { log.Fatal(err) } if _, err := io.Copy(part, file); err != nil { log.Fatal(err) }}Replaces the outline.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typemultipart/form-data
object
bookmarks
required
JSON array of {title, page, children}, sent as text.
string
Example
[{"title": "Summary", "page": 1}]files
required
string format: binary
outputFilename
string | null
Responses
Section titled “Responses”The PDF with its outline replaced
Media typeapplication/pdf
The file, as bytes.
string format: binary
The request is wrong
Media typeapplication/json
The JSON body of every error response.
object
error
required
A stable, machine-readable kind.
string
message
required
What went wrong, for a person.
string
Example
{ "error": "invalid_request", "message": "unknown step 'teleport'"}