[BETA] Gametize Admin API: Project Automation for AI & Integrations (Enterprise)

🧪 BETA — SANDBOX ONLY

Availability: The Gametize Admin API is currently available for Enterprise platforms only and is in BETA testing on the Gametize Sandbox environment. It is not yet available for production use.

For security, Admin API access is currently managed through a Super Administrator-only module. Availability, supported operations, and access permissions may change as the feature develops.

Overview

The Gametize Admin API provides Enterprise customers with a way to automate selected administrative tasks and integrate Gametize with external systems, development tools, and AI assistants.

Current BETA capabilities include:

• uploading supported files
• creating new Gametize Projects from structured Project data
• exporting Project data for supported automation and integration workflows

For example, an external application or AI-assisted workflow can help prepare Project content and assets before creating the Project through the Admin API.

The API is designed for system-to-system automation rather than Player-facing use.

Admin API Access

Admin API credentials are currently created and managed by a Super Administrator.

Access can be limited to specific API operations and revoked when it is no longer required. This helps ensure that integrations receive only the permissions necessary for their intended purpose.

As the Admin API develops, access may be extended to additional Administrator roles and other Gametize plans.

Admin API Documentation

The Enterprise platform provides dedicated Admin API documentation containing the available operations, Project data format, examples, and technical requirements.

The documentation can be viewed without API credentials, but valid Admin API credentials are required to perform API operations.

Official documentation: Gametize Public API Documentation.

Available API operations

1. Upload a file

POST /api/admin/v1/files/upload.json

Upload an image, media file or supported document using multipart/form-data with the required file field. The response provides a fileUrl that can be referenced in project JSON. An optional projectId associates the file with a project. The documented maximum file size is 30 MB; supported formats follow the platform File Manager restrictions.

2. Create a new project from JSON

POST /api/admin/v1/projects/import.json

Submit a valid Gametize project JSON using projectJson, or upload it as projectJsonFile for larger projects. The response includes the newly created projectId and may include a partialImportWarning when some items cannot be imported.

Important: Every successful import creates a new project. This endpoint does not update existing projects.

Authentication

Both operations require Admin API client credentials in these HTTP headers:

• X-Admin-Client-Key
• X-Admin-Client-Secret

Contact your Gametize representative to request credentials for your Sandbox platform. Keep credentials private; do not publish them in articles, project JSON, or client-side code.

Typical workflow

1. Read the project JSON guide and example to prepare a valid project.
2. Upload any required images or files and collect the returned fileUrl values.
3. Place valid image URLs into the relevant project, topic, challenge, or other supported image fields.
4. Submit the project JSON to the import endpoint.
5. Review the resulting project in the Sandbox Admin Dashboard and address any partial-import warnings.

Project JSON requirements and limitations

• The root JSON must contain a project object. A minimal project can contain just projectTitle.
• Use only documented keys. Unknown or misspelled keys can cause a 400 invalid_request error.
• Projects may include topics, challenges, categories, rewards, achievements, maps, and other documented content.
• Supported challenge types include quizzes, surveys, predictions, open responses, flashcards, key challenges, QR challenges, multi-field forms, and selected minigames, subject to their documented requirements.
• scale and api challenge types are not supported by the importer. Imported video challenges do not restore embedded video.
• Some items may be skipped if required data is missing. Rewards, achievements, and maps are imported unpublished.
• Images must use supported absolute HTTPS URLs. The file upload API is the recommended source for image URLs.
• Scheduled publish/expiry dates are not supported in the import format; documented challenge availability windows are supported.

Technical references

• Documentation index
• OpenAPI specification (project-tools.yaml) — endpoint contract, parameters, authentication, responses, and errors
• Project JSON guide — structure, challenge types, image rules, and import behavior
• Example project JSON — import-ready reference

Beta availability and support

This integration is for Sandbox evaluation and testing only. Production availability has not been announced. For API access, questions, or feedback, contact your Gametize representative or support@gametize.com.