RomM Upload API
The upload API from RomM — 4 operation(s) for upload.
The upload API from RomM — 4 operation(s) for upload.
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-upload-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 Upload API
version: 5.4.0
tags:
- name: Upload
paths:
/api/roms/upload/start:
post:
tags:
- Upload
summary: Start Chunked Upload
description: Initiate a chunked ROM upload session.
operationId: start_chunked_upload_api_roms_upload_start_post
security:
- OAuth2PasswordBearer:
- roms.write
- HTTPBasic: []
parameters:
- name: x-upload-platform
in: header
required: true
schema:
type: integer
minimum: 1
title: X-Upload-Platform
- name: x-upload-filename
in: header
required: true
schema:
type: string
title: X-Upload-Filename
- name: x-upload-total-size
in: header
required: true
schema:
type: integer
minimum: 0
title: X-Upload-Total-Size
- name: x-upload-total-chunks
in: header
required: true
schema:
type: integer
minimum: 0
title: X-Upload-Total-Chunks
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/UploadTargetPayload'
- type: 'null'
title: Target
responses:
'201':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Start Chunked Upload Api Roms Upload Start Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/roms/upload/{upload_id}:
put:
tags:
- Upload
summary: Upload Chunk
description: Upload a single chunk of a ROM file.
operationId: upload_chunk_api_roms_upload__upload_id__put
security:
- OAuth2PasswordBearer:
- roms.write
- HTTPBasic: []
parameters:
- name: upload_id
in: path
required: true
schema:
type: string
title: Upload Id
- name: x-chunk-index
in: header
required: true
schema:
type: integer
minimum: 0
title: X-Chunk-Index
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Upload Chunk Api Roms Upload Upload Id Put
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/roms/upload/{upload_id}/complete:
post:
tags:
- Upload
summary: Complete Chunked Upload
description: Assemble all chunks into the final ROM file.
operationId: complete_chunked_upload_api_roms_upload__upload_id__complete_post
security:
- OAuth2PasswordBearer:
- roms.write
- HTTPBasic: []
parameters:
- name: upload_id
in: path
required: true
schema:
type: string
title: Upload Id
responses:
'201':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/roms/upload/{upload_id}/cancel:
post:
tags:
- Upload
summary: Cancel Chunked Upload
description: Cancel a chunked upload session and clean up temp files.
operationId: cancel_chunked_upload_api_roms_upload__upload_id__cancel_post
security:
- OAuth2PasswordBearer:
- roms.write
- HTTPBasic: []
parameters:
- name: upload_id
in: path
required: true
schema:
type: string
title: Upload Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
UploadTargetPayload:
properties:
rom_id:
anyOf:
- type: integer
minimum: 1.0
- type: 'null'
title: Rom Id
description: Upload into this ROM's folder instead of the platform folder.
folder:
type: string
title: Folder
description: Subfolder inside the ROM's folder, relative and forward-slashed. Empty for the root.
default: ''
filename:
anyOf:
- type: string
- type: 'null'
title: Filename
description: The file name. Takes precedence over the header, which cannot carry characters outside Latin-1.
overwrite:
type: boolean
title: Overwrite
description: Replace a file of the same name in the ROM's folder instead of refusing the upload.
default: false
type: object
title: UploadTargetPayload
description: 'Optional body of `/start`: upload into a ROM''s folder instead of the
platform folder, and name the file where the header cannot.'
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
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