Client App BuilderVersion: v3

Read an app's stack and open its sandbox for editing.

GET/ai-builder-api/cli/projects/{projectId}/context

Returns the app's stack, which decides how its code is written, and its kernel bundle, and opens the app's sandbox: read and edit it once sandbox.status is ready. A react_native_app_kernel_v1 app is a phone app: its screens are files under apps/mobile/app-extensions/, registered with POST .../sandbox/extension-routes. Every other stack is a web portal.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:clientportal-ai.write

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

The API version.

Available optionsv3

Example:v3

Path Parameters

projectIdstringrequired

Project identifier.

Possible values: Value must match regular expression ^prj_[A-Za-z0-9_-]+$

Example:prj_01HXQ8Z6J9K2

Response

application/json

Resolved stack manifest and kernel bundle hint.

projectIdstringrequired

The project.

Example:prj_5f0c2a3e

productTargetstringrequired

What the project builds: full_stack (a web portal), mobile or landing_page.

Example:full_stack

stackTemplatestringrequired

The kernel the project is built on.

Example:nuxt_clientportal_app_v1

templateIdstring

The starter template the project was created from, when it had one.

Example:learning-community

stackManifestIdstringrequired

The stack manifest the project's sandbox follows.

Example:nuxt_clientportal_app_v1

kernelBundleHintstringrequired

File name of this stack's kernel bundle.

Example:kernel-nuxt_clientportal_app_v1.tgz

sandboxobjectrequired

The sandbox this call opened. Edit and read once it is ready; call again while it is provisioning (a sandbox reclaimed while the app sat idle is restored from its last save). no_history: a web app was never built, and its first run (externalAgent: true) creates it; a never-built phone app is opened here, so its screens are written before its first build.