# Hyperion

## Docs
- [JSON-RPC API Introduction](https://api.hyperion-project.org/json-rpc-api-introduction-967800m0.md): 
- [JSON-API Commands Overview](https://api.hyperion-project.org/json-api-commands-overview-1023995m0.md): 
- [Connect to Hyperion](https://api.hyperion-project.org/connect-to-hyperion-1027155m0.md): 
- [Components & Priorities](https://api.hyperion-project.org/components-priorities-1024426m0.md): 
- Hyperion API > Authorization [API Authentication - Introduction](https://api.hyperion-project.org/api-authentication-introduction-1027182m0.md): 

## API Docs
- Hyperion API > Authorization [createToken](https://api.hyperion-project.org/createtoken-16806650e0.md): 
- Hyperion API > Authorization [renameToken](https://api.hyperion-project.org/renametoken-16806656e0.md): 
- Hyperion API > Authorization [deleteToken](https://api.hyperion-project.org/deletetoken-16806657e0.md): 
- Hyperion API > Authorization [getTokenlist](https://api.hyperion-project.org/gettokenlist-16311847e0.md): 
- Hyperion API > Authorization [tokenRequired](https://api.hyperion-project.org/tokenrequired-16806665e0.md): Check whether authentication is required to work with the API.
- Hyperion API > Authorization [adminRequired](https://api.hyperion-project.org/adminrequired-16806769e0.md): 
- Hyperion API > Authorization [newPasswordRequired](https://api.hyperion-project.org/newpasswordrequired-16806770e0.md): 
- Hyperion API > Authorization [requestToken](https://api.hyperion-project.org/requesttoken-16311741e0.md): 
- Hyperion API > Authorization [newPassword](https://api.hyperion-project.org/newpassword-16806849e0.md): 
- Hyperion API > Authorization [answerRequest](https://api.hyperion-project.org/answerrequest-16806851e0.md): 
- Hyperion API > Authorization [getPendingTokenRequests](https://api.hyperion-project.org/getpendingtokenrequests-16806852e0.md): 
- Hyperion API > Authorization [login](https://api.hyperion-project.org/login-16806861e0.md): 
- Hyperion API > Authorization [logout](https://api.hyperion-project.org/logout-16806862e0.md): Logout. Hyperion does not verify the login state, this call will always return a success.
- Hyperion API > Information [getSystemInformation](https://api.hyperion-project.org/getsysteminformation-17016022e0.md): Provides data about the live state of Hyperion, broken down into a number of different parts.
- Hyperion API > Information [getSubscriptionInformation](https://api.hyperion-project.org/getsubscriptioninformation-17016059e0.md): Query about active and available subscriptions which where set by [setSubscriptions](apidog://link/endpoint/17016242)
- Hyperion API > Information [getServerInformation](https://api.hyperion-project.org/getserverinformation-16286681e0.md): Retrieve basic information about the Hyperion server and the host it runs on. This information is static and won't change during runtime.
- Hyperion API > Information [getImageSnapshot](https://api.hyperion-project.org/getimagesnapshot-17058289e0.md): Get a snapshot of an image which is currently processed by a given instance.
- Hyperion API > Information [getLedsSnapshot](https://api.hyperion-project.org/getledssnapshot-17058363e0.md): Get a snapshot of LED colors which are currently processed by a given instance.
- Hyperion API > Controls > Input Controls [setColor](https://api.hyperion-project.org/setcolor-17009776e0.md): Set a color for all LEDs or provide a pattern of LED colors.
- Hyperion API > Controls > Input Controls [setEffect](https://api.hyperion-project.org/seteffect-17010032e0.md): Set a color for all LEDs or provide a pattern of LED colors.
- Hyperion API > Controls > Input Controls [setImage](https://api.hyperion-project.org/setimage-17010208e0.md): Set a single image. Supports all [Qt image formats](https://doc.qt.io/qt-6/qimage.html#reading-and-writing-image-files), including png/jpg/gif.
- Hyperion API > Controls > Input Controls [clear](https://api.hyperion-project.org/clear-17010310e0.md): Clear a priority, usually used to revert [setColor](apidog://link/endpoint/17009776), [setEffect](apidog://link/endpoint/17010032) or 
- Hyperion API > Controls > Input Controls [clearAll](https://api.hyperion-project.org/clearall-17010317e0.md): Clear all effects/colors/images regardless which priority they have
- Hyperion API > Controls > Input Controls [selectSource ](https://api.hyperion-project.org/selectsource-17010422e0.md): Sources are always selected automatically by priority (lowest value is the highest priority).
- Hyperion API > Controls > Output Controls [adjustColors](https://api.hyperion-project.org/adjustcolors-17014622e0.md): Adjustments reflect the color calibration. 
- Hyperion API > Controls > Output Controls [setLedMapping](https://api.hyperion-project.org/setledmapping-16286590e0.md): Switch the LED mapping mode for the incoming image.
- Hyperion API > Controls > Output Controls [setVideomode](https://api.hyperion-project.org/setvideomode-17014694e0.md): Switch the video mode. The video mode defines, if the input image is treated as 2D, 3DSBS and 3DTAB.
- Hyperion API > Controls > Subscription Controls [liveImageStream ](https://api.hyperion-project.org/liveimagestream-17014710e0.md): Request a live image stream (if the current source priority supports it, otherwise here may be no response).
- Hyperion API > Controls > Subscription Controls [liveLedColorStream](https://api.hyperion-project.org/liveledcolorstream-17014724e0.md): You can request a live LED color stream with current color values in RGB for each single LED. The update rate is 125ms.
- Hyperion API > Controls > Operational Controls [setComponentState](https://api.hyperion-project.org/setcomponentstate-17015269e0.md): Enable or disable seletceted components at runtime. To get the current state and available components see [getSystemInformation](apidog://link/endpoint/17016022) and or [Components](apidog://link/pages/1024426)
- Hyperion API > Controls > Operational Controls [setInstanceState](https://api.hyperion-project.org/setinstancestate-17015340e0.md): An instance represents an LED hardware instance/device. It runs within its own scope with its own plugin settings, LED layout and calibration.
- Hyperion API > Controls > Operational Controls [switchInstance](https://api.hyperion-project.org/switchinstance-17015700e0.md): On connection to the API you will be connected to the first running instance by default. 
- Hyperion API > Controls > Operational Controls [setSystemState](https://api.hyperion-project.org/setsystemstate-17015955e0.md): Control Hyperion's overall system as a whole.
- Hyperion API > Controls > Operational Controls [setSubscriptions](https://api.hyperion-project.org/setsubscriptions-17016242e0.md): During a serverinfo request the caller can optionally subscribe to updates, either to specific parts or all available data.
- Hyperion API > Configuration [createInstance](https://api.hyperion-project.org/createinstance-17019498e0.md): 
- Hyperion API > Configuration [deleteInstance](https://api.hyperion-project.org/deleteinstance-17019499e0.md): 
- Hyperion API > Configuration [renameInstance](https://api.hyperion-project.org/renameinstance-17019500e0.md): 
- Hyperion API > Configuration [getConfiguration](https://api.hyperion-project.org/getconfiguration-17020899e0.md): Get configuration items which are global or instance specific.
- Hyperion API > Configuration [updateConfiguration](https://api.hyperion-project.org/updateconfiguration-17021074e0.md): Update configuration items. 
- Hyperion API > Configuration [restoreConfiguration](https://api.hyperion-project.org/restoreconfiguration-17021599e0.md): Restore a complete configuration.
- Hyperion API > Configuration [getSchemas](https://api.hyperion-project.org/getschemas-17021032e0.md): Get all schemas describing Hyperion elements and used for message validation.