john-okeefe
b44e4e4709
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.
53 lines
1.1 KiB
Markdown
53 lines
1.1 KiB
Markdown
# Search Books for Matching
|
|
|
|
Query books to find potential matches for linking.
|
|
|
|
**Endpoint**: `POST /api/sync/books/query`
|
|
**Auth**: Required
|
|
**Content-Type**: `application/json`
|
|
|
|
## Request Body
|
|
|
|
| Field | Type | Required | Description |
|
|
|--------|------|-----------|-------------|
|
|
| identifiers | array | No | List of identifiers (ISBN, UUID) |
|
|
| sha256 | string | No | SHA256 hash of book file |
|
|
| title | string | No | Book title |
|
|
| author | string | No | Book author |
|
|
| file_size | integer | No | File size in bytes |
|
|
|
|
### Example Request
|
|
|
|
```json
|
|
{
|
|
"identifiers": ["isbn:978-0345391802", "uuid:abc-123"],
|
|
"sha256": "a1b2c3d4e5f6abc123...",
|
|
"title": "The Hobbit",
|
|
"author": "J.R.R. Tolkien",
|
|
"file_size": 2456789
|
|
}
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"matches": [
|
|
{
|
|
"media_item_id": "uuid-123",
|
|
"bookhoard_uuid": "uuid-123",
|
|
"confidence": 1.0,
|
|
"match_method": "uuid_match"
|
|
}
|
|
],
|
|
"action": "auto_link"
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
|------|-------------|
|
|
| 400 | Invalid query parameters |
|
|
| 401 | Invalid or expired token |
|