Skip to content

Public library integration

Source authored schema: 110 · Endpoint verification: 2026-10-02. These endpoints are optional; the examples and CLI work without an account. The dated hosted compatibility record remains schema 105; downloaded projects retain their recorded schema and can be upgraded locally.

GET https://zoneq.app/api/official-project-library returns JSON with version: 1, publisherId, and projects.

Entry fieldMeaning
id, title, slugPortal identity/display metadata. Portal id differs from authored project.json.projectId.
fileTypezq is editable; zqs is a different runtime format unsupported by this CLI.
schemaVersionRecorded source schema, or null if unknown. Inspect the downloaded bundle too.
projectRevision, sourceFileSha256Published source revision and SHA-256 when recorded; use the hash to check a download against that revision.
allowDownload, canDownloadOwner’s policy and viewer’s computed download permission. Respect these and handle response errors.
allowStudioOpen, canOpenInStudioSeparate Studio-open permissions, not download permission.

The configured official publisher’s public list can change. An absent publisher produces publisherId: null and an empty list. Titles need not be unique; source schemas need not be current.

GET https://zoneq.app/api/projects/{id}/download returns permitted source with a Content-Disposition filename. Follow redirects: storage may serve a short-lived signed URL. Do not persist or redistribute that URL. Permitted public downloads require no login; ordinary authenticated access applies to your own projects.

  • 403: The owner disabled downloads for this viewer.
  • 404: Absent, inaccessible, unpublished/unavailable project or missing source. Private projects are not disclosed to unauthorized viewers.
  • Owners/moderators can have broader access. Do not substitute playback assets for permitted editable source.

Check the source hash when available, then upgrade → extract → edit → pack → validate. Upgrade preserves identity; extract --fork creates an independent project. Local authoring needs no upload endpoint.