v19

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

projects

Create a project

post/project

Response

Expected response to a valid request

slugstring required

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

titlestring required

The title or name of the project

descriptionstring required

A short description of the project

categoriesstring[] required

A list of the categories that the project has

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

The client side support of the project

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

The server side support of the project

bodystring required

A long form description of the project

The status of the project

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

The requested status when submitting for review or scheduling the project for release

additional_categoriesstring[]

A list of categories which are searchable but non-primary

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

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

The project type of the project

downloadsinteger required

The total number of downloads of the project

icon_urlstring nullable

The URL of the project's icon

colorinteger nullable

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

thread_idstring

The ID of the moderation thread associated with this project

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

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

body_urlstring nullable

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

publishedstring ISO-8601 required

The date the project was published

updatedstring ISO-8601 required

The date the project was last updated

approvedstring ISO-8601 nullable

The date the project's status was set to an approved status

queuedstring ISO-8601 nullable

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

followersinteger required

The total number of users following the project

versionsstring[]

A list of the version IDs of the project (will never be empty unless draft status)

game_versionsstring[]

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

loadersstring[]

A list of all of the loaders supported by the project

Example response

{
  "slug": "my_project",
  "title": "My Project",
  "description": "A short description",
  "categories": [
    "technology",
    "adventure",
    "fabric"
  ],
  "client_side": "required",
  "server_side": "optional",
  "body": "A long body describing my project in detail",
  "status": "approved",
  "additional_categories": [
    "technology",
    "adventure",
    "fabric"
  ],
  "issues_url": "https://github.com/my_user/my_project/issues",
  "source_url": "https://github.com/my_user/my_project",
  "wiki_url": "https://github.com/my_user/my_project/wiki",
  "discord_url": "https://discord.gg/AaBbCcDd",
  "donation_urls": [
    {
      "id": "patreon",
      "platform": "Patreon",
      "url": "https://www.patreon.com/my_user"
    }
  ],
  "project_type": "mod",
  "icon_url": "https://cdn.modrinth.com/data/AABBCCDD/b46513nd83hb4792a9a0e1fn28fgi6090c1842639.png",
  "color": 8703084,
  "thread_id": "TTUUVVWW",
  "id": "AABBCCDD",
  "team": "MMNNOOPP",
  "license": {
    "id": "LGPL-3.0-or-later",
    "name": "GNU Lesser General Public License v3 or later"
  },
  "versions": [
    "IIJJKKLL",
    "QQRRSSTT"
  ],
  "game_versions": [
    "1.19",
    "1.19.1",
    "1.19.2",
    "1.19.3"
  ],
  "loaders": [
    "forge",
    "fabric",
    "quilt"
  ],
  "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!"
    }
  ]
}