Get Parse Preview

Method

This API follows the REST methodology.

HTTP Method

GET: Read a run's parse preview — the roles and intent the worker derived from the wireframe, plus the full wireframe node tree.

This is what the plugin shows at the confirm checkpoint on the interactive flow (autoConfirm = false), so a designer can see how the wireframe was understood before assemble spends anything. It is also readable afterwards, as the record of what a completed run was built from.

Naming Convention

The response is proxied verbatim from the internal wf2des-api data plane, so its fields are snake_case. The shape is worker-owned.

Request and Response

Headers

Request Headers

Authorization
Accept
Accept-language

Response Headers

Content-Type

Get Parse

URI

GET /api/v1/organizations/{organization_id}/projects/{project_id}/wf2des/{wf2des_id}/parse

Path Parameters

Name	Type	Required	Description
organization_id	integer	Required	Organization ID
project_id	integer	Required	Project ID
wf2des_id	string	Required	wf2des ID

Response

The response is JSON (HTTP status: 200 OK).

{
  "wf2des_id": "wf2des-001",
  "parse": {
    "artifact_hash": "8f14e45fceea167a5a36dedd4bea2543",
    "sections": [],
    "intent": {},
    "rejected": null
  },
  "parse_tree": {
    "node_id": "2:264664",
    "role": "screen",
    "children": []
  }
}

Response Fields

Name	Type	Description
wf2des_id	string	The run this parse belongs to.
parse	object \| null	The parse block from the result document — sections, intent, the `artifact_hash` used by confirm, and `rejected` when the checkpoint was declined.
parse_tree	object \| null	The full wireframe node tree, inlined from the immutable `parse.json` artifact. `null` when the artifact is absent.

parse.artifact_hash is the value to send as parseArtifactHash when calling POST …/confirm. Confirm compares it against the current artifact and returns 409 on a mismatch, which is how a superseded parse is prevented from being confirmed.

Authentication

Authentication is performed using JSON Web Tokens (JWT) issued by Amazon Cognito. The caller must additionally hold access to the project.

Error Handling

Description	Status Code	Status Name
Missing authentication credentials	401	Unauthorized
Insufficient permissions	403	Forbidden
Parse not found — unknown `wf2des_id`, or parse has not run yet	404	Not Found
Upstream read failure (wf2des-api or S3)	500	Internal Server Error

Processing Flow

Extract organization ID, project ID and wf2des_id from path parameters.
Verify the user has access to the project.
Proxy the read to the internal wf2des-api data plane (X-AI-Service-Token), scoped to the organization and project.
The data plane loads the design_generation_result document and, when artifact_urls.parse is present, inlines the immutable parse.json artifact as parse_tree. The artifact read is optional — a missing artifact yields parse_tree: null rather than an error.
Return the document verbatim.