Skip to main content

API Errors

The API returns a standard GraphQL response: data for successful execution and an errors array when the request cannot be completed fully.

Error Format​

Bad request
POST /graphql
POST /graphql HTTP/1.1
Accept-Language: en
Content-Type: application/json
X-Project-Context: <project-context-token>
X-Request-Id: optional-request-id

{
"documentId": "me",
"variables": {}
}
API response
401 Unauthorized
{
"errors": [
{
"message": "Authentication required",
"extensions": {
"category": "authentication"
}
}
],
"data": null
}

Common Categories​

CategoryCauseCheck
authenticationMissing or expired sessionAuthorization, repeat login
validationInvalid operation variablesField names and types in variables
authorizationInsufficient permissionsUser status, PIN, server access
not_foundEntity was not foundProject, server, shop item, account IDs
internalPlatform errorRetry later or contact support

Common Causes​

  • documentId is misspelled or not listed in the API reference.
  • X-Project-Context is missing, invalid, or outdated.
  • The operation requires Authorization: Bearer <sessionId>, but the user is not authenticated.
  • variables.gameServerId is malformed or points to a server outside the current project.
  • An explicit variables.gameServerId does not belong to the current project.

Logging​

PROJECT_UNAVAILABLE means the project is temporarily unavailable. Show a notice instead of resubmitting the action. Check again later with projectAvailable.

Log documentId, HTTP status, errors[].message, and errors[].extensions.category. Do not log passwords, PIN codes, tokens, secret keys, or personal data without masking.