# Patch

> Play and make games, mods, crossover mods and remixes on Patch.

- [Introduction](https://docs.patch.gg/index.md): Patch is one place to play and make games, mods, crossover mods and remixes.
- [Getting started](https://docs.patch.gg/quickstart.md): Sign in, choose a username and make your first call to the Patch API.
- [patch.json](https://docs.patch.gg/manifest.md): The file that describes a release: what it is, what it needs and how Patch installs it.
- [pch](https://docs.patch.gg/cli.md): The command-line tool for creators and their coding agents.
- [API overview](https://docs.patch.gg/api-reference/introduction.md): Base URL, authentication, errors and conventions of the Patch API.
- [Whether the API and its database are up](https://docs.patch.gg/api-reference/meta/whether-the-api-and-its-database-are-up.md)
- [The signed-in user, their username and orgs](https://docs.patch.gg/api-reference/account/the-signed-in-user-their-username-and-orgs.md)
- [Choose or change your username](https://docs.patch.gg/api-reference/account/choose-or-change-your-username.md): The first time, this also creates your personal org with the same name. Renames are limited to once every 30 days; the old name redirects.
- [Whether a username or org name is free](https://docs.patch.gg/api-reference/account/whether-a-username-or-org-name-is-free.md)
- [Your API keys](https://docs.patch.gg/api-reference/account/your-api-keys.md)
- [Create an API key for an agent or CI](https://docs.patch.gg/api-reference/account/create-an-api-key-for-an-agent-or-ci.md): Only from a signed-in session, so one key can't mint another.
- [Revoke an API key](https://docs.patch.gg/api-reference/account/revoke-an-api-key.md)
- [Search the games mods are made for](https://docs.patch.gg/api-reference/host-games/search-the-games-mods-are-made-for.md)
- [Staff: add a host game](https://docs.patch.gg/api-reference/host-games/staff:-add-a-host-game.md)
- [Find the host game for a store id the desktop app detected](https://docs.patch.gg/api-reference/host-games/find-the-host-game-for-a-store-id-the-desktop-app-detected.md)
- [A host game with its store ids and known builds](https://docs.patch.gg/api-reference/host-games/a-host-game-with-its-store-ids-and-known-builds.md)
- [Staff: record a known build](https://docs.patch.gg/api-reference/host-games/staff:-record-a-known-build.md)
- [Browse public projects, newest first](https://docs.patch.gg/api-reference/projects/browse-public-projects-newest-first.md)
- [Create a project](https://docs.patch.gg/api-reference/projects/create-a-project.md): Send an Idempotency-Key header to make retries safe.
- [A project with its host games and latest public release](https://docs.patch.gg/api-reference/projects/a-project-with-its-host-games-and-latest-public-release.md)
- [Releases you can see, newest first](https://docs.patch.gg/api-reference/releases/releases-you-can-see-newest-first.md)
- [Create a draft release and get upload targets](https://docs.patch.gg/api-reference/releases/create-a-draft-release-and-get-upload-targets.md): Send the parsed patch.json and every file's path, SHA-256 and size. Only files Patch doesn't already store come back as upload targets. Sending the same version again while it's a draft replaces it, so a retried publish resumes.
- [A release with its manifest, files and requirements](https://docs.patch.gg/api-reference/releases/a-release-with-its-manifest-files-and-requirements.md)
- [Check the uploads, then publish (staff) or queue for review](https://docs.patch.gg/api-reference/releases/check-the-uploads-then-publish-staff-or-queue-for-review.md)
- [Short-lived download links for every file](https://docs.patch.gg/api-reference/releases/short-lived-download-links-for-every-file.md)
- [Finish a multipart upload](https://docs.patch.gg/api-reference/releases/finish-a-multipart-upload.md)
- [Search the asset library](https://docs.patch.gg/api-reference/assets/search-the-asset-library.md): Full-text search, ranked, with ties going to prepared assets. One hit per group of alternatives unless group=false. `unapplied` lists filters that weren't used and why; with few hits, `relax` says what to drop.
- [Fields, values, counts and ranges for a query](https://docs.patch.gg/api-reference/assets/fields-values-counts-and-ranges-for-a-query.md)
- [Plan adding assets to a project (the assets_add dry run)](https://docs.patch.gg/api-reference/assets/plan-adding-assets-to-a-project-the-assets_add-dry-run.md): Per item: ready (files with URLs and hashes), pending (conversion queued; call again to poll) or failed (AS-215 with alternatives). Writes nothing to a project; starts conversion for unprepared items.
- [A license's name, URL, duties and full text](https://docs.patch.gg/api-reference/assets/a-licenses-name-url-duties-and-full-text.md)
- [One asset: variants with file URLs, capabilities per runtime, license and credit](https://docs.patch.gg/api-reference/assets/one-asset:-variants-with-file-urls-capabilities-per-runtime-license-and-credit.md): Ids contain a colon and can contain slashes: URL-encode them.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.