๐งช BETA โ SANDBOX ONLY
Availability: This API is currently in Beta testing and works only on the Gametize Sandbox environment. It is not yet available for production use. Features and behavior may change during testing.
Overview
The Gametize Admin API supports AI-assisted tools and custom integrations that upload files and create new Gametize Projects from structured JSON. This allows developers and AI assistants to prepare project content programmatically.
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-KeyX-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
- Read the project JSON guide and example to prepare a valid project.
- Upload any required images or files and collect the returned
fileUrlvalues. - Place valid image URLs into the relevant project, topic, challenge, or other supported image fields.
- Submit the project JSON to the import endpoint.
- 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
projectobject. A minimal project can contain justprojectTitle. - Use only documented keys. Unknown or misspelled keys can cause a
400 invalid_requesterror. - 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.
scaleandapichallenge 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.
Comments
0 comments
Please sign in to leave a comment.