Skip to main content
Client App BuilderVersion: v3

Read a publish job's progress.

GET/ai-builder-api/projects/{projectId}/infra/publish-jobs/{publishJobId}

Reports a publish job's progress. Poll it every few seconds until status is succeeded, when publishedUrl is the live site, or failed, when error says why.

Authorizations

Authorizationstringheaderrequired

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

Scope:clientportal-ai.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

The API version.

Available optionsv3
Example:v3

Path Parameters

projectIdstringrequired

The project.

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

Example:prj_5f0c2a3e
publishJobIdstringrequired

The publish job promote-to-production returned.

Example:job_3f9a1c2b7d4e5f6a7b8c9d0e

Response

Current publish-job state and immutable domain snapshot.

jobIdstringrequired

The publish job.

Example:job_3f9a1c2b7d4e5f6a7b8c9d0e
projectIdstringrequired

The project.

Example:prj_5f0c2a3e
statusstringrequired

succeeded and failed are final.

Available optionsqueuedrunningsucceededfailed
Example:succeeded
tierstring | nullnullablerequired

published once the site is live.

Example:published
publishedUrl(string | null)<uri>nullablerequired

The live site, once the job succeeded.

Example:https://5f0c2a3e.app.clientclub.net
hostnamestring | nullnullablerequired

The managed address the app is published to.

Example:5f0c2a3e.app.clientclub.net
aliasesstring[]required

The active custom domains the live site also serves.

Example:["portal.acmefitness.com"]
domainRevisioninteger | nullnullablerequired

The managed address's revision this publish took.

Possible values: >= 0

Example:1
errorstring | nullnullablerequired

Why the job failed.

Example:null
createdAtstring<date-time>required

When the job was accepted.

Example:2026-10-23T09:42:00.000Z
updatedAtstring<date-time>required

When the job last changed.

Example:2026-10-23T09:43:05.000Z