Skip to main content
POST
Create a project

Authorizations

Authorization
string
header
required

An API key (pch_...) or the token from pch login.

Body

application/json
owner
string
required
Example:

"patch"

slug
string
required
Example:

"demo-mod"

name
string
required
Required string length: 1 - 100
summary
string
Maximum string length: 300
source_visibility
enum<string>

open_source: anyone can read and fork it. source_available: readable, no forks. source_private: shared with reviewers only.

Available options:
open_source,
source_available,
source_private
code_license
string
Maximum string length: 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9.+-]*$
Example:

"MIT"

art_license
string
Maximum string length: 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9.+-]*$
Example:

"MIT"

Response

Created

id
string<uuid>
required
owner
string
required
slug
string
required
handle
string
required
Example:

"patch/demo-mod"

name
string
required
summary
string | null
required
description
string | null
required
kind
enum<string> | null
required

Derived from the latest published release

Available options:
web_game,
mod,
crossover_mod,
remix,
null
status
enum<string>
required
Available options:
active,
archived,
removed
cover_url
string | null
required
min_players
integer | null
required
max_players
integer | null
required
source_visibility
enum<string>
required

open_source: anyone can read and fork it. source_available: readable, no forks. source_private: shared with reviewers only.

Available options:
open_source,
source_available,
source_private
code_license
string
required

License of the code; defaults to MIT

Maximum string length: 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9.+-]*$
Example:

"MIT"

art_license
string
required

License of original art and other assets; defaults to CC-BY-4.0

Maximum string length: 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9.+-]*$
Example:

"MIT"

host_games
object[]
required
latest_release
object | null
required
created_at
string
required
updated_at
string
required