Back to mods
Omi's API project artwork

CurseForge · Minecraft mod

Omi's API

Omi's API is a server-sided mod that includes a configurable API for developers to interact with.

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which Omi's API release should I use?

Updated 2 years ago
Latest stable file omiapi-1.0.jar
Game version 1.19.2
Loader Forge

Omi's API omiapi-1.0.jar targets 1.19.2 with Forge. The project page does not say whether this file belongs on the client, dedicated server, or both. No extra mods listed for this file.

Where it goes

Is Omi's API required on the client, server, or both?

The project page does not say whether this file belongs on the client, dedicated server, or both.

Client Source doesn’t say
Dedicated server Source doesn’t say
Loader for this release Forge
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

The source does not explicitly classify this release as client-only or server-only.

What else does Omi's API omiapi-1.0.jar need?

omiapi-1.0.jar. Change the file and its required mods may change too.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add Omi's API without breaking your instance.

Built for Omi's API omiapi-1.0.jar. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use omiapi-1.0.jar. It targets 1.19.2 with Forge; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    The project page does not say whether this file belongs on the client, dedicated server, or both.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside omiapi-1.0.jar. It opens that exact file at the source.

About this project

What does Omi's API add?

Omi's_Api_banner

Omi's Minecraft API is a server-side mod which creates a simple API to connect with.

Getting Started

  • Download the mod and place it on your server.
  • When starting the server, the mod will boot up and the config file should show up in the config folder.
  • Modify the omiapi-common.toml file as you like.
  • Be sure to change the auth settings to avoid third-party connections
  • Restart the server
  • If when first sending a request to the server, you notice an error in the server console, just ignore it.

About the API

The API allows server admins to connect and interact remotely while maintaining a simple and secure style. This tool will come in handy while working with integrations or webhooks.

Currently, the API supports:

  • Retrieving the general status of the server
  • Retrieving detailed information about the server (players, config, memory...)
  • Retrieving the player list
  • Retrieving a player's inventory
  • Retrieving the Ban List
  • Broadcasting a Minecraft-formatted message
  • Whispering to a user
  • Executing a command
  • Shutdown the server
  • Kick a player
  • Ban a player (Both via IP and GameProfile/UUID)
  • Unbanning a player (IP or GameProfile/UUID)

Moreover, the API not only uses Basic Auth to ensure security but it can also be configured to disable routes you may not use.

You can see the routes documentation here.

Project description from CurseForge.

Pick your setup

Omi's API by Minecraft version and loader

Choose the version and loader you play, then open the matching release.

1 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

Omi's API versions and loaders

1 of 1 releases match

Looking for an older file? The official CurseForge project page is in Resources.