API Key api usage is not documented

[mjsir911]

I have searched the existing issues, both open and closed, to make sure this is not a duplicate report.

• Yes

The bug

Hi,

Your documentation on https://immich.app/docs/ does not include usage for using the API key.

I assume it's Authorization: Bearer <api key>, although I'm still having trouble getting this working. this ticket is not a request for help.

There is relevant/related docs:

• https://immich.app/docs/features/command-line-interface#obtain-the-api-key
• https://www.answeroverflow.com/m/1332787912953299035
• How to use immich API for dummies? #6228 (specifically: How to use immich API for dummies? #6228 (comment))

I don't really believe "pressing the authorize key on the dynamic documentation website" is a sufficient fix for this issue. searching for "authorization", "bearer", or "api key" should probably point to a page that at least outlines the authorize button & provides some examples.

it looks like x-api-key also works?? and perhaps ?x-api-key=

This should all be documented somewhere.

The OS that Immich Server is running on

Firefox

Version of Immich Server

0

Version of Immich Mobile App

0

Platform with the issue

• Server
• Web
• Mobile

Your docker-compose.yml content

-

Your .env content

-

Reproduction steps

...

Relevant log output

Additional information

No response

[mmomjian]

I agree this could be expanded on. Converting to FR, if anyone wants to add some docs feel free.

[schuhbacca]

And for reference yes, the API key is an x-api-key.
Bearer token is used for the authentication flow via user authentication