# setImage ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /json-rpc/input/image: post: summary: setImage deprecated: false description: >- 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. For best practices on using priorites, see [Components & Priorities](https://api.hyperion-project.org/components-priorities-1024426m0.md). tags: - Hyperion API/Controls/Input Controls - Websocket - HTTP/S parameters: [] requestBody: content: application/json: schema: type: object properties: command: type: string enum: - image x-apidog-enum: - value: image name: '' description: '' description: The type of command to execute. instance: type: array items: &ref_0 $ref: '#/components/schemas/instance%20-%20single' uniqueItems: true description: >- List of instance indices (0-254) to which the command applies. An empty array applies a command to all instances. priority: type: integer minimum: 1 maximum: 253 description: >- The priority of this input (1-253). Lower values override higher ones. origin: type: string minLength: 4 maxLength: 20 description: Origin string (4-20 characters), e.g., the application name. duration: type: integer examples: - -1 minimum: -1 description: >- Duration in milliseconds to keep this input. Use -1 for indefinite duration. imagedata: type: string description: Base64-encoded image string. imagewidth: type: integer minimum: 0 description: Width of the image in pixels. imageheight: type: integer minimum: 0 description: Height of the image in pixels. format: type: string enum: - auto description: Image format, via "auto" the format will be evaluated scale: type: integer minimum: 25 maximum: 2000 description: Resize percentage of the image (25–2000). name: type: string description: Optional name for the image input. tan: type: integer minimum: 0 examples: - 4711 description: Transaction number for tracking requests and responses. additionalProperties: false x-apidog-orders: - command - 01JVFF0Y93620XZSVKFBAVHEJB - 01JVFHN08EBAD43BZ0H5Q3XTCH - 01JVFJNHKS007BA36KPD2SYNZ1 - 01JVFHN70X6XCEYVSZ17Z5HAY9 x-apidog-refs: 01JVFF0Y93620XZSVKFBAVHEJB: $ref: '#/components/schemas/instance%20-%20multiple' 01JVFHN08EBAD43BZ0H5Q3XTCH: $ref: '#/components/schemas/priorityParameters' 01JVFHN70X6XCEYVSZ17Z5HAY9: $ref: '#/components/schemas/tan' 01JVFJNHKS007BA36KPD2SYNZ1: $ref: '#/components/schemas/imageDetails' required: - command - priority - imagedata x-apidog-ignore-properties: - instance - priority - origin - duration - imagedata - imagewidth - imageheight - format - scale - name - tan example: command: image imagedata: VGhpcyBpcyBubyBpbWFnZSEgOik= name: Name of Image format: auto priority: 50 duration: 5000 origin: My Fancy App responses: '200': x-apidog-name: Success description: '' content: application/json: schema: type: object properties: command: type: string description: The command executed subcommand: type: string description: The sub-command executed success: type: boolean description: Result, if the request excuted successfully info: type: object properties: {} x-apidog-orders: [] description: Information requested additionalProperties: true x-apidog-ignore-properties: [] error: type: string description: Reason why a request did not execute successfully errorData: type: array items: type: object properties: description: type: string x-apidog-orders: - description x-apidog-ignore-properties: [] description: Detailed error explaination tan: type: integer description: Request's transaction number x-apidog-orders: - 01JV5M76DZ4M3GA4AD8Y4G69AP x-apidog-refs: 01JV5M76DZ4M3GA4AD8Y4G69AP: $ref: '#/components/schemas/response' required: - command - success - tan x-apidog-ignore-properties: - command - subcommand - success - info - error - errorData - tan example: command: image success: true tan: 139 headers: {} security: - bearer: [] x-apidog-folder: Hyperion API/Controls/Input Controls x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/894413/apis/api-17010208-run components: schemas: instance - single: type: integer minimum: 0 maximum: 254 description: Instance index (0-254) to which the command applies. x-apidog-folder: '' imageDetails: type: object properties: imagedata: type: string description: Base64-encoded image string. imagewidth: type: integer minimum: 0 description: Width of the image in pixels. imageheight: type: integer minimum: 0 description: Height of the image in pixels. format: type: string enum: - auto description: Image format, via "auto" the format will be evaluated scale: type: integer minimum: 25 maximum: 2000 description: Resize percentage of the image (25–2000). name: type: string description: Optional name for the image input. x-apidog-orders: - imagedata - imagewidth - imageheight - format - scale - name required: - imagedata x-apidog-folder: '' x-apidog-ignore-properties: [] tan: type: object properties: tan: type: integer minimum: 0 examples: - 4711 description: Transaction number for tracking requests and responses. x-apidog-orders: - tan title: tan x-apidog-folder: '' x-apidog-ignore-properties: [] priorityParameters: type: object properties: priority: type: integer minimum: 1 maximum: 253 description: >- The priority of this input (1-253). Lower values override higher ones. origin: type: string minLength: 4 maxLength: 20 description: Origin string (4-20 characters), e.g., the application name. duration: type: integer examples: - -1 minimum: -1 description: >- Duration in milliseconds to keep this input. Use -1 for indefinite duration. x-apidog-orders: - priority - origin - duration required: - priority x-apidog-folder: '' x-apidog-ignore-properties: [] instance - multiple: type: object properties: instance: type: array items: *ref_0 uniqueItems: true description: >- List of instance indices (0-254) to which the command applies. An empty array applies a command to all instances. x-apidog-orders: - instance x-apidog-folder: '' x-apidog-ignore-properties: [] response: type: object properties: command: type: string description: The command executed subcommand: type: string description: The sub-command executed success: type: boolean description: Result, if the request excuted successfully info: type: object properties: {} x-apidog-orders: [] description: Information requested additionalProperties: true x-apidog-ignore-properties: [] error: type: string description: Reason why a request did not execute successfully errorData: type: array items: type: object properties: description: type: string x-apidog-orders: - description x-apidog-ignore-properties: [] description: Detailed error explaination tan: type: integer description: Request's transaction number required: - command - success - tan x-apidog-orders: - command - subcommand - success - info - error - errorData - tan x-apidog-folder: '' x-apidog-ignore-properties: [] securitySchemes: bearer: type: http scheme: bearer servers: - url: http://{{host}}:8090 description: Develop Env - url: https://{{host}}:8092 description: Testing Env security: [] ```