About the Containers Projects API

The Containers Projects API lets you work with the projects of the Wix AI coding agent. A project is a mobile app that a user builds by chatting with the coding agent. Use this API to retrieve projects, resume work on them, save design changes, and restore earlier versions.

With the Containers Projects API, you can:

  • Retrieve a project and its current status.
  • Resume work on a project, so the coding agent can continue to build it.
  • Save design changes as a new draft release, and preview them.
  • Restore an earlier version of a project.

To chat with the coding agent about a project, use the Containers Chat API.

The project lifecycle

A project's status changes in one direction only:

  1. PLANNING: The user and the coding agent plan the app. New projects start with this status.
  2. PLAN_READY: The plan is finalized, and the first build of the app is about to start.
  3. BUILDING: The coding agent builds the app. The project stays in this status, and the user can continue to request changes.

You can resume a project only when its status is BUILDING.

Releases and versions

Each design save and each edit by the coding agent creates a new draft release of the project's app. The project's headReleaseId is the release that the project is currently on. Your app previews this release, and the next design save or edit branches from it.

  • Save Project Design creates a draft release from the release that the user is viewing, and sets headReleaseId to the new release.
  • Restore Release sets headReleaseId to an earlier release.

Neither method changes the project's live app.

When you specify a conversationId, both methods add a CHECKPOINT message to that conversation, so the user sees the saved or restored version in the chat.

Platforms

Most new projects have platform set to HIMALAYA_MOBILE. For these projects, call Get Himalaya Authorization to check that the current user can work on the project. The response also includes the canonical slug of the project's app in canonicalApp, which Save Project Design requires for these projects.

Older projects have platform set to IOS or ANDROID.

Before you begin

It's important to note the following points before starting to code:

  • The methods described in this API reference are in Beta.
  • Projects belong to the Wix site they're created on.
  • Save Project Design requires a short-lived control credential for the project's app releases, in himalayaControlToken.
  • Only a project's owner can restore a release.
  • Resume Project starts the project's remote development environment in the background. The API doesn't report when the environment is ready.

Use cases

Terminology

  • Project: An app that a user builds with the Wix AI coding agent.
  • Release: A saved version of a project's app. Design saves and edits by the coding agent create draft releases.
  • Head release: The release that a project is currently on, in headReleaseId.
  • Design-token document: A JSON document that holds the design values of a project's app, such as its colors and fonts.
  • Remote development environment: The environment in which the coding agent builds the project's app.
  • Checkpoint: A message in a conversation that marks a saved or restored version of the project.

Last updated: 14 October 2026

Did this help?