Bookshelf Scanner API Docs

Please contact me at alexandre@devforgoodcollective.com to get the API URL and key.

Scan Books

POST /scan-bookshelf

Send a base64 image and receive a list of detected books, with multiple choices per book detected.

Headers

Name
Value

Content-Type

application/json

x-api-key

<api_key>

Body

Name
Type
Description

image_base64

string

Base64 image:

  • max: 10Mo

  • jpeg/png/gif/webp

  • Starts with data:image/

Response

[
	{
		"detectedTitle": "string",
		"detectedAuthors": "string",
		"detectedPublisher": "string",
		"detectedLanguage": "string ISO 639-1",
		"booksFound": [
			{
				"source": "hybrid | google | open_library",
				"title": "string",
				"subtitle": "string",
				"authors": "string",
				"publisher": "string",
				"isbn_13": "string",
				"isbn_10": "string",
				"language": "string ISO 639-1",
				"cover_url": "string",
				"relevance_score": number between 0-100
			},
		]
	}
]

Last updated