16bb5dbc54f4

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-107759141.0 KB

projects

Create a project

post/project

Response

Expected response to a valid request

idstring required

The ID of the project, encoded as a base62 string

teamstring required

The ID of the team that has ownership of this project

titlestring required

The title or name of the project

descriptionstring required

A short sentence summarizing the project, no more than a sentence or two.

bodystring required

A long form description of the project

The status of the project

project_type'mod' | 'modpack' | 'resourcepack' | 'shader' required

The project type of the project

categoriesstring[] required

A list of the featured categories that the project has.

additional_categoriesstring[] required

A list of additional categories that the project also has. These are supplementary to the featured categories, and does not include them again.

environmentEnvironmentEnum[] required

All the environments that versions of this project support. Not in any particular order, we recommend using the environment information on a version instead. For an explanation of each environment, see the blog post here: https://modrinth.com/news/article/new-environments/#new-system

game_versionsstring[] required

A list of all of the game versions supported by the project

loadersstring[] required

A list of all of the loaders supported by the project. These vary based on project type.

versionsstring[] required

A list of the version IDs of the project

publishedstring ISO-8601 required

The date the project was created

updatedstring ISO-8601 required

The date the latest version of the project was created

downloadsinteger required

The total number of downloads of the project

followersinteger required

The total number of users following the project

thread_idstring required

The ID of the moderation thread associated with this project

monetization_status'monetized' | 'demonetized' | 'force-demonetized' required

slugstring nullable

The slug of a project, used for vanity URLs. Regex: ^[\w!@$()`.+,"\-']{3,64}$

organizationstring nullable

The ID of the organization that owns this project

requested_status'approved' | 'archived' | 'unlisted' | 'private' | 'draft' nullable

The requested status when submitting for review or scheduling the project for release. Approved status refers to "Public" visibility.

approvedstring ISO-8601 nullable

The date the project was first published

queuedstring ISO-8601 nullable

The date the project's status was submitted to moderators for review

icon_urlstring nullable

The URL of the project's icon

raw_icon_urlstring nullable

The URL of the project's icon without CDN transforms applied

colorinteger nullable

The RGB color of the project, automatically generated from the project icon

issues_urlstring nullable

An optional link to where to submit bugs or issues with the project

source_urlstring nullable

An optional link to the source code of the project

wiki_urlstring nullable

An optional link to the project's wiki page or other relevant information

discord_urlstring nullable

An optional invite link to the project's discord.

client_side'required' | 'optional' | 'unsupported' | 'unknown' required

Deprecated - use environment instead.

server_side'required' | 'optional' | 'unsupported' | 'unknown' required

Deprecated - use environment instead.

body_urlstring nullable

Deprecated - The link to the long description of the project. Always null, only kept for legacy compatibility.

Example response

{
  "id": "AABBCCDD",
  "team": "MMNNOOPP",
  "body": "A long body describing my project in detail",
  "status": "approved",
  "project_type": "mod",
  "categories": [
    "technology",
    "adventure",
    "fabric"
  ],
  "additional_categories": [
    "technology",
    "adventure",
    "fabric"
  ],
  "environment": [
    "client_and_server"
  ],
  "game_versions": [
    "1.19",
    "1.19.1",
    "1.19.2",
    "1.19.3"
  ],
  "loaders": [
    "neoforge",
    "fabric"
  ],
  "versions": [
    "IIJJKKLL",
    "QQRRSSTT"
  ],
  "license": {
    "id": "LGPL-3.0-or-later",
    "name": "GNU Lesser General Public License v3 or later"
  },
  "gallery": [
    {
      "url": "https://cdn.modrinth.com/data/AABBCCDD/images/009b7d8d6e8bf04968a29421117c59b3efe2351a.png",
      "featured": true,
      "title": "My awesome screenshot!",
      "description": "This awesome screenshot shows all of the blocks in my mod!"
    }
  ],
  "thread_id": "TTUUVVWW",
  "slug": "my_project",
  "organization": "AABBCCDD",
  "icon_url": "https://cdn.modrinth.com/data/AABBCCDD/b46513nd83hb4792a9a0e1fn28fgi6090c1842639.png",
  "raw_icon_url": "https://cdn.modrinth.com/data/AABBCCDD/b46513nd83hb4792a9a0e1fn28fgi6090c1842639-raw.png",
  "color": 8703084,
  "issues_url": "https://github.com/modrinth/code/issues",
  "source_url": "https://github.com/modrinth/code",
  "wiki_url": "https://github.com/modrinth/code/wiki",
  "discord_url": "https://discord.gg/modrinth",
  "donation_urls": [
    {
      "id": "patreon",
      "platform": "Patreon",
      "url": "https://www.patreon.com/my_user"
    }
  ],
  "client_side": "required",
  "server_side": "optional"
}