Download the original file

GET

/api/v1/publications/{publicationId}/file

curl --request GET \
  --url http://localhost:8080/api/v1/publications/1/file \
  --header 'Authorization: Bearer <token>' \
  --header 'Range: bytes=0-65535'

Serves the file as it is on disk. Supports Range for partial reads and If-Modified-Since for revalidation. A publication from a source library is streamed from its source, which may send the whole file instead of a range, as Komga does. Kavita sends a folder of images as a ZIP it makes. A chapter from an extension that’s an EPUB or PDF is downloaded through the extension and sent whole, with an ETag naming the file; one that’s pages has no file.

Authorizations

• session
• basic

Parameters

Path Parameters

publicationId

required

integer format: int64

Header Parameters

Range

string

Example

bytes=0-65535

Responses

200

The whole file.

string format: binary

string format: binary

string format: binary

Headers

ETag

string

Changes whenever the file’s content changes. Send it back in If-None-Match.

206

The requested byte range.

Media typeapplication/octet-stream

string format: binary

Headers

Content-Range

string

304

The client’s copy is current.

401

The request has no valid session token.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

404

The resource does not exist.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

409

The file changed on disk since it was scanned. A rescan has started; retry after it finishes.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

416

The range is outside the file.

500

The server failed; details are in its log.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

502

The publication is from a source library, and its source couldn’t be read (source_unavailable) or its extension failed (source_failed); the message says why.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}