REST API

The mod.io REST API is the foundation that allows you to add UGC support to your game. You can manage your game(s) and API access via your mod.io library dashboard.

mod.io REST API

A complete guide to mod.io's API functionality, such as authentication, integration and reference codes.

Features

Explore a variety of customizable offerings that work alongside the UE Plugin to enhance UGC in your game.

How it works

Compatible with all builds of your game on all platforms and stores, mod.io is a clientless and standalone solution which gives you complete control over your modding ecosystem.

Tools & implementation

Once you have completed the Step 1 of the mod.io Getting Started Guide, you can start integrating the mod.io REST API into your game, tools and sites. There are 3 options to get connected which you can use interchangeably depending on your needs.

Here's the breakdown of each option:

Option	Usage	Suited for	Docs
API	For connecting directly to the mod.io REST API.	Web apps that need a JSON REST API, or game developers that like a challenge and want control over their implementation.	Documentation
Official Plugins	If you've built your game using Unreal or Unity Engines, we have built bespoke plugins to streamline your UGC experience.	Any Unity or Unreal Engine game.	Available below
SDK	Drop our open source C/C++ SDK into your game to call mod.io functionality.	Developers that want a SDK that abstracts the uploading, downloading and unzip flows behind easy to use function calls.	Documentation
Tools/Plugins	Use tools, plugins and wrappers created by the community to make implementation easy.	Game developers that want a pre-built modding solution for their engine (Unity, Unreal, GameMaker, Construct) of choice.	Available below

Official tools

Plugins and wrappers made or supported by the mod.io team.

	Unity Plugin SDK Documentation Sample Project		Unreal Plugin SDK Documentation UE4 Sample Project UE5 Sample Project
	C/C++ SDK SDK Documentation		GameMaker SDK Getting Started

Community tools

Plugins and wrappers made by our passionate community.

Community Tools

Is there a tool out there that should be added to the list? Let us know at developers@mod.io.

	Construct 2 Plugin SDK Getting Started		Haxe Wrapper SDK Getting Started
	Modio.NET SDK Getting Started		Rust Wrapper SDK Getting Started Tutorials
	Python Wrapper SDK Getting Started Tutorials		Common Lisp Github Getting Started
	Command Line Tool CMD Getting Started		GitHub Action Mod Uploader GitHub Usage

Here is a brief list of the things to know about our API

• All requests to the API must be made over HTTPS (TLS).
• All API responses are always in application/json format.
• Any POST request with a binary payload must supply the Content-Type: multipart/form-data header.
• Any non-binary POST, PUT and DELETE requests must supply the Content-Type: application/x-www-form-urlencoded header.
• Any non-binary payload can be supplied in JSON format using the input_json parameter.

Explore the API

To explore what the API has to offer, head over to our complete REST API Documentation.