Plans

Get the plan’s clickable prototype

GET
/v1/projects/{projectSlug}/plans/{planShortId}/prototype

Authorization

bearerAuth
AuthorizationBearer <token>

A personal API key (psk_…) or an OAuth access token (plan_at_…). Scopes: read, write.

In: header

Path Parameters

projectSlug*string

Project slug, e.g. recipe-box.

planShortId*string

Plan handle within the project, e.g. PLAN-12.

Query Parameters

html?string

Pass 1 to download the rendered HTML instead.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/projects/string/plans/string/prototype"
{  "prototype": {    "status": "string",    "specsFingerprint": "string",    "stale": true,    "htmlBytes": 0,    "path": "string",    "updatedAt": "string"  }}