AnthoLume API v1 (1.0.0)

Download OpenAPI specification:

REST API for AnthoLume document management system

Documents

List documents

Authorizations:

BearerAuth

query Parameters

page	integer <int64> Default: 1
limit	integer <int64> Default: 9
search	string

Responses

Response samples

200
401
500

Content type

application/json

{"documents": [{"id": "string",
"title": "string",
"author": "string",
"description": "string",
"isbn10": "string",
"isbn13": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted": true,
"words": 0,
"filepath": "string",
"percentage": 0.1,
"total_time_seconds": 0,
"wpm": 0.1,
"seconds_per_percent": 0,
"last_read": "2019-08-24T14:15:22Z"
}
],
"total": 0,
"page": 0,
"limit": 0,
"next_page": 0,
"previous_page": 0,
"search": "string"
}

Upload a new document

Authorizations:

BearerAuth

Request Body schema: multipart/form-data
required

document_file

required

string <binary>

Responses

Response samples

200
400
401
500

Content type

application/json

{"document": {"id": "string",
"title": "string",
"author": "string",
"description": "string",
"isbn10": "string",
"isbn13": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted": true,
"words": 0,
"filepath": "string",
"percentage": 0.1,
"total_time_seconds": 0,
"wpm": 0.1,
"seconds_per_percent": 0,
"last_read": "2019-08-24T14:15:22Z"
}
}

Get a single document

Authorizations:

BearerAuth

path Parameters

id

required

string

Responses

Response samples

200
401
404
500

Content type

application/json

{"document": {"id": "string",
"title": "string",
"author": "string",
"description": "string",
"isbn10": "string",
"isbn13": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted": true,
"words": 0,
"filepath": "string",
"percentage": 0.1,
"total_time_seconds": 0,
"wpm": 0.1,
"seconds_per_percent": 0,
"last_read": "2019-08-24T14:15:22Z"
}
}

Update document editable fields

Authorizations:

BearerAuth

path Parameters

id

required

string

Request Body schema: application/json
required

title	string
author	string
description	string
isbn10	string
isbn13	string
cover_gbid	string

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"author": "string",
"description": "string",
"isbn10": "string",
"isbn13": "string",
"cover_gbid": "string"
}

Response samples

200
400
401
404
500

Content type

application/json

{"document": {"id": "string",
"title": "string",
"author": "string",
"description": "string",
"isbn10": "string",
"isbn13": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted": true,
"words": 0,
"filepath": "string",
"percentage": 0.1,
"total_time_seconds": 0,
"wpm": 0.1,
"seconds_per_percent": 0,
"last_read": "2019-08-24T14:15:22Z"
}
}

Get document cover image

Authorizations:

BearerAuth

path Parameters

id

required

string

Responses

Response samples

401
404
500

Content type

application/json

{"code": 0,
"message": "string"
}

Upload document cover image

Authorizations:

BearerAuth

path Parameters

id

required

string

Request Body schema: multipart/form-data
required

cover_file

required

string <binary>

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"document": {"id": "string",
"title": "string",
"author": "string",
"description": "string",
"isbn10": "string",
"isbn13": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted": true,
"words": 0,
"filepath": "string",
"percentage": 0.1,
"total_time_seconds": 0,
"wpm": 0.1,
"seconds_per_percent": 0,
"last_read": "2019-08-24T14:15:22Z"
}
}

Download document file

Authorizations:

BearerAuth

path Parameters

id

required

string

Responses

Response samples

401
404
500

Content type

application/json

{"code": 0,
"message": "string"
}

Progress

List progress records

Authorizations:

BearerAuth

query Parameters

page	integer <int64> Default: 1
limit	integer <int64> Default: 15
document	string

Responses

Response samples

200
401
500

Content type

application/json

{"progress": [{"title": "string",
"author": "string",
"device_name": "string",
"device_id": "string",
"percentage": 0.1,
"progress": "string",
"document_id": "string",
"user_id": "string",
"created_at": "2019-08-24T14:15:22Z"
}
],
"page": 0,
"limit": 0,
"next_page": 0,
"previous_page": 0,
"total": 0
}

Update document progress

Authorizations:

BearerAuth

Request Body schema: application/json
required

document_id required	string
percentage required	number <double>
progress required	string
device_id required	string
device_name required	string

Responses

Request samples

Payload

Content type

application/json

{"document_id": "string",
"percentage": 0.1,
"progress": "string",
"device_id": "string",
"device_name": "string"
}

Response samples

200
400
401
500

Content type

application/json

{"document_id": "string",
"timestamp": "2019-08-24T14:15:22Z"
}

Get document progress

Authorizations:

BearerAuth

path Parameters

id

required

string

Responses

Response samples

200
401
404
500

Content type

application/json

{"progress": {"title": "string",
"author": "string",
"device_name": "string",
"device_id": "string",
"percentage": 0.1,
"progress": "string",
"document_id": "string",
"user_id": "string",
"created_at": "2019-08-24T14:15:22Z"
}
}

Activity

Get activity data

Authorizations:

BearerAuth

query Parameters

doc_filter	boolean Default: false
document_id	string
page	integer <int64> Default: 1
limit	integer <int64> Default: 25

Responses

Response samples

200
401
500

Content type

application/json

{"activities": [{"document_id": "string",
"device_id": "string",
"start_time": "2019-08-24T14:15:22Z",
"title": "string",
"author": "string",
"duration": 0,
"start_percentage": 0.1,
"end_percentage": 0.1,
"read_percentage": 0.1
}
],
"page": 0,
"limit": 0,
"next_page": 0,
"previous_page": 0,
"total": 0
}

Create activity records

Authorizations:

BearerAuth

Request Body schema: application/json
required

device_id required	string
device_name required	string
required	Array of objects (CreateActivityItem)

Responses

Request samples

Payload

Content type

application/json

{"device_id": "string",
"device_name": "string",
"activity": [{"document_id": "string",
"start_time": 0,
"duration": 0,
"page": 0,
"pages": 0
}
]
}

Response samples

200
400
401
500

Content type

application/json

{"added": 0
}

Settings

Get user settings

Authorizations:

BearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"user": {"username": "string",
"is_admin": true
},
"timezone": "string",
"devices": [{"id": "string",
"device_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"last_synced": "2019-08-24T14:15:22Z"
}
]
}

Update user settings

Authorizations:

BearerAuth

Request Body schema: application/json
required

password	string
new_password	string
timezone	string

Responses

Request samples

Payload

Content type

application/json

{"password": "string",
"new_password": "string",
"timezone": "string"
}

Response samples

200
400
401
500

Content type

application/json

{"user": {"username": "string",
"is_admin": true
},
"timezone": "string",
"devices": [{"id": "string",
"device_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"last_synced": "2019-08-24T14:15:22Z"
}
]
}

Auth

User login

Request Body schema: application/json
required

username required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

200
400
401
500

Content type

application/json

{"username": "string",
"is_admin": true
}

User registration

Request Body schema: application/json
required

username required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

201
400
403
500

Content type

application/json

{"username": "string",
"is_admin": true
}

User logout

Authorizations:

BearerAuth

Responses

Response samples

401

Content type

application/json

{"code": 0,
"message": "string"
}

Get current user info

Authorizations:

BearerAuth

Responses

Response samples

200
401

Content type

application/json

{"username": "string",
"is_admin": true
}

Info

Get server information

Responses

Response samples

200
500

Content type

application/json

{"version": "string",
"search_enabled": true,
"registration_enabled": true
}

Home

Get home page data

Authorizations:

BearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"database_info": {"documents_size": 0,
"activity_size": 0,
"progress_size": 0,
"devices_size": 0
},
"streaks": {"streaks": [{"window": "string",
"max_streak": 0,
"max_streak_start_date": "string",
"max_streak_end_date": "string",
"current_streak": 0,
"current_streak_start_date": "string",
"current_streak_end_date": "string"
}
]
},
"graph_data": {"graph_data": [{"date": "string",
"minutes_read": 0
}
]
},
"user_statistics": {"wpm": {"all": [{"user_id": "string",
"value": 0.1
}
],
"year": [{"user_id": "string",
"value": 0.1
}
],
"month": [{"user_id": "string",
"value": 0.1
}
],
"week": [{"user_id": "string",
"value": 0.1
}
]
},
"duration": {"all": [{"user_id": "string",
"value": 0.1
}
],
"year": [{"user_id": "string",
"value": 0.1
}
],
"month": [{"user_id": "string",
"value": 0.1
}
],
"week": [{"user_id": "string",
"value": 0.1
}
]
},
"words": {"all": [{"user_id": "string",
"value": 0.1
}
],
"year": [{"user_id": "string",
"value": 0.1
}
],
"month": [{"user_id": "string",
"value": 0.1
}
],
"week": [{"user_id": "string",
"value": 0.1
}
]
}
}
}

Get user streaks

Authorizations:

BearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"streaks": [{"window": "string",
"max_streak": 0,
"max_streak_start_date": "string",
"max_streak_end_date": "string",
"current_streak": 0,
"current_streak_start_date": "string",
"current_streak_end_date": "string"
}
]
}

Get daily read stats graph data

Authorizations:

BearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"graph_data": [{"date": "string",
"minutes_read": 0
}
]
}

Get user statistics (leaderboards)

Authorizations:

BearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"wpm": {"all": [{"user_id": "string",
"value": 0.1
}
],
"year": [{"user_id": "string",
"value": 0.1
}
],
"month": [{"user_id": "string",
"value": 0.1
}
],
"week": [{"user_id": "string",
"value": 0.1
}
]
},
"duration": {"all": [{"user_id": "string",
"value": 0.1
}
],
"year": [{"user_id": "string",
"value": 0.1
}
],
"month": [{"user_id": "string",
"value": 0.1
}
],
"week": [{"user_id": "string",
"value": 0.1
}
]
},
"words": {"all": [{"user_id": "string",
"value": 0.1
}
],
"year": [{"user_id": "string",
"value": 0.1
}
],
"month": [{"user_id": "string",
"value": 0.1
}
],
"week": [{"user_id": "string",
"value": 0.1
}
]
}
}

Search

Search external book sources

Authorizations:

BearerAuth

query Parameters

query required	string
source required	string Enum: "LibGen" "Annas Archive"

Responses

Response samples

200
400
401
500

Content type

application/json

{"results": [{"id": "string",
"title": "string",
"author": "string",
"language": "string",
"series": "string",
"file_type": "string",
"file_size": "string"
}
],
"source": "string",
"query": "string"
}

Download search result

Authorizations:

BearerAuth

Request Body schema: application/x-www-form-urlencoded
required

source required	string
title required	string
author required	string
id required	string

Responses

Response samples

401
500

Content type

application/json

{"code": 0,
"message": "string"
}

Admin

Get admin page data

Authorizations:

BearerAuth

Responses

Response samples

200
401

Content type

application/json

{"database_info": {"documents_size": 0,
"activity_size": 0,
"progress_size": 0,
"devices_size": 0
}
}

Perform admin action (backup, restore, etc.)

Authorizations:

BearerAuth

Request Body schema: multipart/form-data
required

action required	string Enum: "BACKUP" "RESTORE" "METADATA_MATCH" "CACHE_TABLES"
backup_types	Array of strings (BackupType) Items Enum: "COVERS" "DOCUMENTS"
restore_file	string <binary>

Responses

Response samples

200
400
401
500

Content type

application/json

{"message": "string"
}

Get all users

Authorizations:

BearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"users": [{"id": "string",
"admin": true,
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Create, update, or delete user

Authorizations:

BearerAuth

Request Body schema: application/x-www-form-urlencoded
required

operation required	string (OperationType) Enum: "CREATE" "UPDATE" "DELETE"
user required	string
password	string
is_admin	boolean

Responses

Response samples

200
400
401
500

Content type

application/json

{"users": [{"id": "string",
"admin": true,
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Get import directory list

Authorizations:

BearerAuth

query Parameters

directory	string
select	string

Responses

Response samples

200
401
500

Content type

application/json

{"current_path": "string",
"items": [{"name": "string",
"path": "string"
}
]
}

Perform import

Authorizations:

BearerAuth

Request Body schema: application/x-www-form-urlencoded
required

directory required	string
type required	string (ImportType) Enum: "DIRECT" "COPY"

Responses

Response samples

200
400
401
500

Content type

application/json

{"results": [{"id": "string",
"name": "string",
"path": "string",
"status": "FAILED",
"error": "string"
}
]
}

Get import results

Authorizations:

BearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"results": [{"id": "string",
"name": "string",
"path": "string",
"status": "FAILED",
"error": "string"
}
]
}

Get logs with optional filter

Authorizations:

BearerAuth

query Parameters

filter	string
page	integer <int64> >= 1
limit	integer <int64> >= 1

Responses

Response samples

200
401
500

Content type

application/json

{"logs": ["string"
],
"filter": "string",
"page": 0,
"limit": 0,
"next_page": 0,
"previous_page": 0,
"total": 0
}

AnthoLume API v1 (1.0.0)

Documents

List documents

Authorizations:

query Parameters

Responses

Response samples

Upload a new document

Authorizations:

Request Body schema: multipart/form-datarequired

Responses

Response samples

Get a single document

Authorizations:

path Parameters

Responses

Response samples

Update document editable fields

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get document cover image

Authorizations:

path Parameters

Responses

Response samples

Upload document cover image

Authorizations:

path Parameters

Request Body schema: multipart/form-datarequired

Responses

Response samples

Download document file

Authorizations:

path Parameters

Responses

Response samples

Progress

List progress records

Authorizations:

query Parameters

Responses

Response samples

Update document progress

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get document progress

Authorizations:

path Parameters

Responses

Response samples

Activity

Get activity data

Authorizations:

query Parameters

Responses

Response samples

Create activity records

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Settings

Get user settings

Authorizations:

Responses

Response samples

Update user settings

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: multipart/form-data
required

Request Body schema: application/x-www-form-urlencoded
required