PALWORLDRUN.
SearchSaved
Navigation

CREATE · PACKAGE · VERIFY

Palworld Run data and API reference

Document the data actually published by Palworld Run, including schemas, stable identifiers, version metadata and limitations. Source-site API endpoints, private credentials, scanning claims and write operations cannot be carried over as if the new site operates them.

No Palworld Run accountOriginal documentation

Read the public data

GET /api/data/{name} returns a published local JSON table. Supported names are pals, items, skills, recipes, mods, servers, cards and meta. Use each record's stable identifier and inspect meta for the source baseline before comparing values across releases. The API describes acquired data rather than a guarantee of current-game completeness.

GET /api/data/meta
GET /api/data/pals
GET /api/data/recipes

Create an anonymous submission

POST /api/community accepts JSON with kind, target and the content fields for that kind. Supported content includes mods, servers, comments, reviews, bug reports, guides, decks and collections. Empty honeypot and acknowledge: true are required. The response contains id, editToken and status. Save the token privately; it is the credential for that record.

{
  "kind": "comment",
  "target": "guide:/docs/users",
  "body": "Describe a reproducible observation here.",
  "honeypot": "",
  "acknowledge": true
}

Publication is an explicit state

Mod, server, comment, review, bug and guide submissions enter pending moderation. Structured decks and collections can publish directly. A successful 201 response means the record was created with the returned status; it does not mean an external release was uploaded or a pending submission was approved. GET /api/community?kind=…&target=… returns published records.

Manage a record

Use GET, PUT or DELETE /api/community/:id with Authorization: Bearer followed by the editToken returned at creation. Keep that token out of public URLs, shared screenshots and exported public content. Losing the token removes the documented self-service management path; the site does not provide an account login.

Authorization: Bearer YOUR_EDIT_TOKEN

Votes

POST /api/votes accepts targetKind, targetId, vote (1 or -1), and an empty honeypot. The service limits each IP to one vote per target per day; this is a server-enforced limit rather than a logged-in identity. GET on the votes endpoint returns the stored counts.

{
  "targetKind": "guide",
  "targetId": "/docs/users",
  "vote": 1,
  "honeypot": ""
}

Handle failures

API errors use a JSON object containing error. Check the HTTP status before using a response, display the actual failure and retain the draft when a submission fails. Validation, storage and moderation outcomes are separate from a client-side saved state. This API is operated by Palworld Run and has no dependency on the reference site's endpoints.

Sources and verification

The official loader and maintainer documentation were retrieved on October 23, 2026. Examples are explanatory and have not been executed in Palworld by this project. The extended ID snapshot has no verified game-version label. Linked player data uses v1.0.3, while current official news includes v1.0.5.

KEEP BUILDING

Documentation routes

Palworld mod documentation

Find the game identifiers, installation guides and authoring references needed to use or release a mod. Follow the route for your loader and platform, then verify the installed result and keep a removal path.

Open document

Mod author documentation

Choose the smallest change that solves the mod's purpose, identify its game records, and test on the side where it runs. Package the result with dependencies, compatibility evidence, credits and removal instructions.

Open document

Creating Mods for Palworld.

Develop a reversible change from an explicit requirement. Choose a data edit, Lua behavior or cooked content as appropriate, test a minimal example, then package only the files needed for the release.

Open document

Choose the Right Mod Format

Use a data-edit framework for supported table changes, Lua for runtime behavior, and cooked resources or Blueprint logic when the requirement needs assets or engine content. Distribution and dependencies affect the format decision.

Open document

Create Your First UE4SS Lua Mod

UE4SS Lua mods place their entry script inside a mod's Scripts directory. Begin with visible logging, consult the current hook API, and keep engine-object work on the appropriate thread before adding game behavior.

Open document

Palworld Modding Kit & LogicMods

The community modding kit is a separate toolchain from Pocketpair's package uploader. Verify its prerequisites and game compatibility, then test a minimal cooked LogicMod before importing a large project.

Open document