Files
bookhoard/docs/developer/api/book-matching/auto_link_books.md
T
john-okeefe b44e4e4709 docs: remove Phase X placeholders from API documentation
Clean up API documentation files by removing Phase X references:

Remove 'API Explorer will be inserted here in Phase X' placeholders from:
- 70+ API endpoint documentation files
- Authentication endpoints (login, logout, register, refresh)
- User endpoints (profile, settings, password)
- Device endpoints (registration, sync, shelves)
- Library endpoints (CRUD, folders, visibility)
- Media endpoints (items, progress, highlights, notes)
- Admin endpoints (users, analytics)
- Sync endpoints (Kobo, KOReader)
- OPDS endpoints
- Scanner endpoints
- Queue endpoints

These placeholders were from planning documents and have no meaning
to API consumers. The documentation is now clean and ready for use.
2026-02-13 21:50:44 -05:00

932 B

Auto Link Books

Automatically link books to media items based on matching metadata.

Endpoint: POST /api/sync/auto-link-books Auth: Required Content-Type: application/json

Request Body

Field Type Required Description
device_id string (UUID) Yes Device UUID
threshold float No Match confidence threshold (0.0-1.0, default: 0.7)

Example Request

{
  "device_id": "550e8400-e29b-41d4-a716-446655440000",
  "threshold": 0.8
}

Response (200 OK)

{
  "message": "Auto-link completed",
  "linked_count": 15,
  "unmatched_count": 5,
  "links": [
    {
      "book_id": "book-123",
      "media_item_id": "uuid",
      "confidence": 0.95
    }
  ]
}

Error Responses

Code Description
400 Invalid request data
401 Invalid or expired token
404 Device not found