RomM Screenshots API
The screenshots API from RomM — 3 operation(s) for screenshots.
The screenshots API from RomM — 3 operation(s) for screenshots.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/romm:romm-screenshots-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: RomM Screenshots API
version: 5.4.0
tags:
- name: Screenshots
paths:
/api/screenshots:
post:
tags:
- Screenshots
summary: Add Screenshot
description: 'Upload a per-user gallery screenshot for a ROM.
Stored under the user''s asset folder (not the ROM folder) and flagged
`is_gallery=True` so it surfaces in the gallery; `is_public=False` so it
stays private until the owner shares it.'
operationId: add_screenshot_api_screenshots_post
security:
- OAuth2PasswordBearer:
- assets.write
- HTTPBasic: []
parameters:
- name: rom_id
in: query
required: true
schema:
type: integer
title: Rom Id
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_add_screenshot_api_screenshots_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ScreenshotSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/screenshots/{id}/content:
get:
tags:
- Screenshots
summary: Download Screenshot
description: 'Download a screenshot file. Owner can download any of their screenshots;
everyone else only public ones.'
operationId: download_screenshot_api_screenshots__id__content_get
security:
- OAuth2PasswordBearer:
- assets.read
- HTTPBasic: []
parameters:
- name: id
in: path
required: true
schema:
type: integer
minimum: 1
description: Screenshot internal id.
title: Id
description: Screenshot internal id.
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'404':
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/screenshots/{id}:
put:
tags:
- Screenshots
summary: Update Screenshot
description: Toggle a gallery screenshot's public/private visibility (owner only).
operationId: update_screenshot_api_screenshots__id__put
security:
- OAuth2PasswordBearer:
- assets.write
- HTTPBasic: []
parameters:
- name: id
in: path
required: true
schema:
type: integer
minimum: 1
description: Screenshot internal id.
title: Id
description: Screenshot internal id.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Body_update_screenshot_api_screenshots__id__put'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ScreenshotSchema'
'404':
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Screenshots
summary: Delete Screenshot
description: Delete a gallery screenshot — its file and DB row (owner only).
operationId: delete_screenshot_api_screenshots__id__delete
security:
- OAuth2PasswordBearer:
- assets.write
- HTTPBasic: []
parameters:
- name: id
in: path
required: true
schema:
type: integer
minimum: 1
description: Screenshot internal id.
title: Id
description: Screenshot internal id.
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'404':
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
Body_update_screenshot_api_screenshots__id__put:
properties:
is_public:
type: boolean
title: Is Public
type: object
required:
- is_public
title: Body_update_screenshot_api_screenshots__id__put
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ScreenshotSchema:
properties:
id:
type: integer
title: Id
rom_id:
type: integer
title: Rom Id
user_id:
type: integer
title: User Id
file_name:
type: string
title: File Name
file_name_no_tags:
type: string
title: File Name No Tags
file_name_no_ext:
type: string
title: File Name No Ext
file_extension:
type: string
title: File Extension
file_path:
type: string
title: File Path
file_size_bytes:
type: integer
title: File Size Bytes
full_path:
type: string
title: Full Path
download_path:
type: string
title: Download Path
missing_from_fs:
type: boolean
title: Missing From Fs
created_at:
type: string
title: Created At
updated_at:
type: string
title: Updated At
is_gallery:
type: boolean
title: Is Gallery
default: false
is_public:
type: boolean
title: Is Public
default: false
type: object
required:
- id
- rom_id
- user_id
- file_name
- file_name_no_tags
- file_name_no_ext
- file_extension
- file_path
- file_size_bytes
- full_path
- download_path
- missing_from_fs
- created_at
- updated_at
title: ScreenshotSchema
Body_add_screenshot_api_screenshots_post:
properties:
screenshotFile:
type: string
contentMediaType: application/octet-stream
title: Screenshotfile
description: Screenshot file to upload.
type: object
required:
- screenshotFile
title: Body_add_screenshot_api_screenshots_post
securitySchemes:
OAuth2PasswordBearer:
type: oauth2
flows:
password:
scopes:
me.read: View your profile
roms.read: View ROMs
platforms.read: View platforms
assets.read: View assets
devices.read: View devices
firmware.read: View firmware
roms.user.read: View user-rom properties
collections.read: View collections
playlists.read: View music playlists
me.write: Modify your profile
assets.write: Modify assets
devices.write: Modify devices
roms.user.write: Modify user-rom properties
collections.write: Modify collections
playlists.write: Modify music playlists
roms.write: Modify ROMs
platforms.write: Modify platforms
firmware.write: Modify firmware
users.read: View users
users.write: Modify users
tasks.run: Run tasks
logs.read: View backend logs
tokenUrl: /token
HTTPBasic:
type: http
scheme: basic