# RomM Roms API

**Canonical:** https://apis.io/apis/romm/romm-roms-api/  
**Provider:** RomM — https://apis.io/providers/romm/  
**Base URL:** https://demo.romm.app  
**Documentation:** https://docs.romm.app/latest/developers/api-reference/

RomM Roms API is one of 33 APIs that [RomM](https://apis.io/providers/romm/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include roms. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The roms API from RomM — 42 operation(s) for roms.

## Operations (48)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/roms/upload/start` | Start Chunked Upload |
| PUT | `/api/roms/upload/{upload_id}` | Upload Chunk |
| POST | `/api/roms/upload/{upload_id}/complete` | Complete Chunked Upload |
| POST | `/api/roms/upload/{upload_id}/cancel` | Cancel Chunked Upload |
| GET | `/api/roms/{id}/files` | Get Romfile |
| GET | `/api/roms/{id}/files/content/{file_name}` | Get Romfile Content |
| DELETE | `/api/roms/{rom_id}/files/{file_id}` | Delete Rom File |
| GET | `/api/roms/{rom_id}/files/{file_id}/progress` | Get Rom File Progress |
| PUT | `/api/roms/{rom_id}/files/{file_id}/progress` | Update Rom File Progress |
| GET | `/api/roms/{id}/easyrpg/{path}` | Get Easyrpg File |
| GET | `/api/roms/{id}/installs` | Get Rom Installs |
| POST | `/api/roms/{id}/manuals` | Add Rom Manuals |
| DELETE | `/api/roms/{id}/manuals` | Delete Rom Manuals |
| POST | `/api/roms/{id}/manuals/redownload` | Redownload Rom Manual |
| POST | `/api/roms/{id}/manuals/files` | Add Rom Manual File |
| DELETE | `/api/roms/{id}/manuals/files/{file_id}` | Delete Rom Manual File |
| POST | `/api/roms/{id}/walkthroughs/files` | Add Rom Walkthrough File |
| POST | `/api/roms/{id}/walkthroughs/gamefaqs` | Add Rom Gamefaqs Walkthrough |
| DELETE | `/api/roms/{id}/walkthroughs/files/{file_id}` | Delete Rom Walkthrough File |
| GET | `/api/roms/{id}/soundtracks/metadata` | Get Rom Soundtrack Metadata |
| POST | `/api/roms/{id}/soundtracks` | Add Rom Soundtracks |
| DELETE | `/api/roms/{id}/soundtracks/{file_id}` | Delete Rom Soundtrack |
| POST | `/api/roms/{id}/screenshots` | Add Rom Screenshots |
| DELETE | `/api/roms/{id}/screenshots/{file_id}` | Delete Rom Screenshot |
| GET | `/api/roms/{id}/notes` | Get Rom Notes |
| POST | `/api/roms/{id}/notes` | Create Rom Note |
| GET | `/api/roms/{id}/notes/identifiers` | Get Rom Note Identifiers |
| PUT | `/api/roms/{id}/notes/{note_id}` | Update Rom Note |
| DELETE | `/api/roms/{id}/notes/{note_id}` | Delete Rom Note |
| POST | `/api/roms/{id}/patch` | Patch Rom |
| GET | `/api/roms` | Get Roms |
| GET | `/api/roms/identifiers` | Get Rom Identifiers |
| GET | `/api/roms/random` | Get Random Rom |
| GET | `/api/roms/download` | Download Roms |
| GET | `/api/roms/by-metadata-provider` | Get Rom By Metadata Provider |
| GET | `/api/roms/by-hash` | Get Rom By Hash |
| GET | `/api/roms/filters` | Get Rom Filters |
| GET | `/api/roms/{id}/simple` | Get Rom Simple |
| GET | `/api/roms/{id}/similar` | Get Similar Roms |
| GET | `/api/roms/{id}` | Get Rom |
| PUT | `/api/roms/{id}` | Update Rom |
| HEAD | `/api/roms/{id}/content/{file_name}` | Head Rom Content |
| GET | `/api/roms/{id}/content/{file_name}` | Get Rom Content |
| POST | `/api/roms/physical` | Create Physical Rom |
| POST | `/api/roms/{id}/convert-to-folder` | Convert Rom To Folder |
| POST | `/api/roms/delete` | Delete Roms |
| PUT | `/api/roms/{id}/props` | Update Rom User |
| PUT | `/api/roms/{id}/identity` | Update Rom Identity |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/romm/openapi/romm-roms-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/romm/json-schema/romm-detailed-rom-schema-schema.json
- **JSONSchema** — https://artifacts.apis.io/romm/json-schema/romm-simple-rom-schema-schema.json
- **JSONSchema** — https://artifacts.apis.io/romm/json-schema/romm-config-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/romm/json-schema/romm-body-update-rom-api-roms-id-put-schema.json
- **JSONSchema** — https://artifacts.apis.io/romm/json-schema/romm-platform-schema-schema.json
- **JSONSchema** — https://artifacts.apis.io/romm/json-schema/romm-search-rom-schema-schema.json

## Other RomM APIs (12)

- [RomM Activity API](https://apis.io/apis/romm/romm-activity-api/)
- [RomM Audit API](https://apis.io/apis/romm/romm-audit-api/)
- [RomM Auth API](https://apis.io/apis/romm/romm-auth-api/)
- [RomM Client Tokens API](https://apis.io/apis/romm/romm-client-tokens-api/)
- [RomM Collections API](https://apis.io/apis/romm/romm-collections-api/)
- [RomM Config API](https://apis.io/apis/romm/romm-config-api/)
- [RomM Device Auth API](https://apis.io/apis/romm/romm-device-auth-api/)
- [RomM Devices API](https://apis.io/apis/romm/romm-devices-api/)
- [RomM Export API](https://apis.io/apis/romm/romm-export-api/)
- [RomM Feeds API](https://apis.io/apis/romm/romm-feeds-api/)
- [RomM Firmware API](https://apis.io/apis/romm/romm-firmware-api/)
- [RomM Logs API](https://apis.io/apis/romm/romm-logs-api/)

## Tags

roms

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/romm/romm-roms-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/romm/.