`kavita_client.api.opds.get_api_opds_api_key_image`¶

Module Contents¶

`asyncio_detailed`	This returns a streamed image following OPDS-PS v1.2
`sync_detailed`	This returns a streamed image following OPDS-PS v1.2

async kavita_client.api.opds.get_api_opds_api_key_image.asyncio_detailed(api_key: str, *, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET, series_id: int | kavita_client.types.Unset = UNSET, volume_id: int | kavita_client.types.Unset = UNSET, chapter_id: int | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, save_progress: bool | kavita_client.types.Unset = True) → kavita_client.types.Response[Any]¶

This returns a streamed image following OPDS-PS v1.2

Args:: api_key (str): library_id (int | Unset): series_id (int | Unset): volume_id (int | Unset): chapter_id (int | Unset): page_number (int | Unset): save_progress (bool | Unset): Default: True.
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any]

kavita_client.api.opds.get_api_opds_api_key_image.sync_detailed(api_key: str, *, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET, series_id: int | kavita_client.types.Unset = UNSET, volume_id: int | kavita_client.types.Unset = UNSET, chapter_id: int | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, save_progress: bool | kavita_client.types.Unset = True) → kavita_client.types.Response[Any]¶

This returns a streamed image following OPDS-PS v1.2

Args:: api_key (str): library_id (int | Unset): series_id (int | Unset): volume_id (int | Unset): chapter_id (int | Unset): page_number (int | Unset): save_progress (bool | Unset): Default: True.
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any]