ReqArchitect Design Preview API
The design_preview API from ReqArchitect — 8 operation(s) for design_preview.
The design_preview API from ReqArchitect — 8 operation(s) for design_preview.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/archiet:archiet-design-preview-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Archiet — AI-Native Architecture-to-Code SaaS Platform…
version: 1.0.0
tags:
- name: design_preview
paths:
/api/journey/{session_id}/design-preview:
post:
operationId: post_journey_design_preview
summary: Generate (or regenerate) a design preview for the session
tags:
- design_preview
responses:
'201':
description: Preview created
'200':
description: Preview skipped (LLM unavailable)
'400':
description: Bad Request
'401':
description: Unauthorized
'402':
description: Plan upgrade required or usage limit reached
'404':
description: Not Found
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
/api/journey/{session_id}/design-preview/latest:
get:
operationId: get_journey_design_preview_latest
summary: Get the latest design preview for the session
tags:
- design_preview
responses:
'200':
description: OK
'401':
description: Unauthorized
'404':
description: Not Found
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
/api/design-preview/{preview_id}:
get:
operationId: get_design_preview_by_id
summary: Get a design preview by id
tags:
- design_preview
responses:
'200':
description: OK
'401':
description: Unauthorized
'404':
description: Not Found
security:
- cookieAuth: []
parameters:
- name: preview_id
in: path
required: true
schema:
type: integer
/api/design-preview/{preview_id}/refine:
post:
operationId: post_design_preview_refine
summary: Re-render a single screen within a draft preview
tags:
- design_preview
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
'402':
description: Usage limit reached
'404':
description: Not Found
security:
- cookieAuth: []
parameters:
- name: preview_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
required:
- screen_id
- instructions
properties:
screen_id:
type: string
instructions:
type: string
maxLength: 2000
/api/design-preview/{preview_id}/refine-all:
post:
operationId: post_design_preview_refine_all
summary: Re-render every screen in a draft preview with the same instructions
tags:
- design_preview
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
'402':
description: Usage limit reached
'404':
description: Not Found
'503':
description: All LLM providers failed
security:
- cookieAuth: []
parameters:
- name: preview_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
required:
- instructions
properties:
instructions:
type: string
maxLength: 2000
/api/design-preview/{preview_id}/share:
post:
operationId: post_design_preview_share
summary: Issue or rotate a read-only share token for team review
tags:
- design_preview
responses:
'200':
description: OK
'401':
description: Unauthorized
'404':
description: Not Found
security:
- cookieAuth: []
parameters:
- name: preview_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
properties:
rotate:
type: boolean
delete:
operationId: delete_design_preview_share
summary: Revoke the share token — the public URL stops working
tags:
- design_preview
responses:
'200':
description: OK
'401':
description: Unauthorized
'404':
description: Not Found
security:
- cookieAuth: []
parameters:
- name: preview_id
in: path
required: true
schema:
type: integer
/api/public/design-preview/share/{token}:
get:
operationId: get_public_design_preview_by_token
summary: Fetch a shared design preview (no auth)
tags:
- design_preview
responses:
'200':
description: OK
'404':
description: Not Found
parameters:
- name: token
in: path
required: true
schema:
type: string
/api/design-preview/{preview_id}/approve:
post:
operationId: post_design_preview_approve
summary: Lock a draft preview so codegen picks it up
tags:
- design_preview
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Unauthorized
'404':
description: Not Found
security:
- cookieAuth: []
parameters:
- name: preview_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
properties:
tokens_override:
type: object
components:
securitySchemes:
cookieAuth:
type: apiKey
in: cookie
name: access_token_cookie
description: JWT access token stored in httpOnly cookie