ReqArchitect Journey API
The journey API from ReqArchitect — 17 operation(s) for journey.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/archiet:archiet-journey-api"
All apis
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.
Get an API 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 Specification
openapi: 3.2.0
info:
title: Archiet — AI-Native Architecture-to-Code SaaS Platform…
version: 1.0.0
tags:
- name: journey
paths:
/api/journey/sessions/{session_id}/import-repo:
post:
operationId: import_repo_for_journey
summary: Start a code scan for a GitHub repo linked to a journey session
tags:
- journey
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- repo_full_name
properties:
repo_full_name:
type: string
example: owner/repo
branch:
type: string
default: main
responses:
'201':
description: Scan started
'400':
description: Invalid input or no GitHub connection
'402':
description: Professional plan required
/api/journey/sessions/{session_id}/scan-status:
get:
operationId: get_scan_status
summary: Poll code scan progress for a journey session
tags:
- journey
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Scan status with progress info
/api/journey/sessions/{session_id}/scan-result:
get:
operationId: get_scan_result
summary: Get full code scan result for a journey session
tags:
- journey
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Full scan result
'402':
description: Professional plan required
'404':
description: No scan for this session
/api/journey/sessions/{session_id}/manifest:
patch:
operationId: patch_manifest
summary: Apply user corrections to the extracted PRD manifest
tags:
- journey
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
properties:
entities:
type: array
items:
type: string
screens:
type: array
items:
type: string
frs:
type: array
items:
type: string
renamed_entities:
type: object
additionalProperties:
type: string
responses:
'200':
description: Manifest updated
'400':
description: No manifest to edit
'404':
description: Session not found
/api/journey/sessions/{session_id}/extraction-report:
get:
operationId: get_extraction_report
summary: Get PRD extraction V&V report with async status for a journey session
tags:
- journey
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Extraction status and report (report is null while processing)
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
extraction_status:
type: string
enum:
- none
- pending
- processing
- complete
- failed
report:
type: object
nullable: true
properties:
document_length:
type: integer
chars_processed:
type: integer
chunks_used:
type: integer
extraction_confidence:
type: number
edited_by_user:
type: boolean
completeness:
type: object
properties:
estimated_entities:
type: integer
extracted_entities:
type: integer
estimated_screens:
type: integer
extracted_screens:
type: integer
estimated_frs:
type: integer
extracted_frs:
type: integer
overall_ratio:
type: number
validation_warnings:
type: array
items:
type: string
auto_repairs:
type: array
items:
type: string
entities_extracted:
type: array
items:
type: object
properties:
name:
type: string
confidence:
type: number
screens_extracted:
type: array
items:
type: object
properties:
name:
type: string
confidence:
type: number
frs_extracted:
type: array
items:
type: object
properties:
id:
type: string
description:
type: string
confidence:
type: number
'404':
description: Session not found
/api/journey/sessions:
get:
operationId: get_journey_sessions
summary: Get sessions
tags:
- journey
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
security:
- cookieAuth: []
post:
operationId: post_journey_sessions
summary: Create/invoke sessions
tags:
- journey
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- cookieAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
system_description_text:
type: string
pcf_category:
type: string
example: '7.0'
ui_framework:
type: string
enum:
- shadcn
- mui
- antd
- angular
- vue
default: shadcn
backend_framework:
type: string
enum:
- flask-nextjs
- fastapi-nextjs
- go-chi-nextjs
- java-spring-nextjs
default: flask-nextjs
description: Backend language/framework for generated code
/api/journey/sessions/{session_id}:
get:
operationId: get_journey_sessions_by_session_id
summary: Get /api/journey/sessions/{session_id}
tags:
- journey
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
/api/journey/sessions/{session_id}/advise:
get:
operationId: get_journey_sessions_by_session_id_advise
summary: Get advise
tags:
- journey
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
/api/journey/sessions/{session_id}/complete:
post:
operationId: post_journey_sessions_by_session_id_complete
summary: Create/invoke complete
tags:
- journey
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
/api/journey/sessions/{session_id}/documents:
post:
operationId: post_journey_sessions_by_session_id_documents
summary: Upload PRD / reference documents to a journey session
description: 'Accepts multipart/form-data with one or more files (PDF, DOCX, TXT, MD, RST). Free plan: 1 file / 1 MB. Paid plans: 5 files / 10 MB each. Extracted text is injected into all subsequent LLM prompts for the session.'
tags:
- journey
responses:
'200':
description: Documents uploaded and text extracted successfully
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
files_processed:
type: integer
document_names:
type: array
items:
type: string
'400':
description: Bad Request — unsupported file type or file too large
'401':
description: Unauthorized
'402':
description: Plan limit reached — upgrade to upload more documents
'403':
description: Forbidden
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required:
- files
properties:
files:
type: array
items:
type: string
format: binary
description: One or more document files (PDF, DOCX, TXT, MD, RST)
/api/journey/sessions/{session_id}/estimate-costs:
post:
operationId: post_journey_sessions_by_session_id_estimate_costs
summary: Create/invoke estimate costs
tags:
- journey
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
/api/journey/sessions/{session_id}/extract-elements:
post:
operationId: post_journey_sessions_by_session_id_extract_elements
summary: Create/invoke extract elements
tags:
- journey
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
/api/journey/sessions/{session_id}/messages:
post:
operationId: post_journey_sessions_by_session_id_messages
summary: Create/invoke messages
tags:
- journey
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
/api/journey/sessions/{session_id}/options:
post:
operationId: post_journey_sessions_by_session_id_options
summary: Create/invoke options
tags:
- journey
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
/api/journey/sessions/{session_id}/options/{option_id}/select:
post:
operationId: post_journey_sessions_by_session_id_options_by_option_id_select
summary: Create/invoke select
tags:
- journey
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
- name: option_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
/api/journey/sessions/{session_id}/stream:
post:
operationId: post_journey_sessions_by_session_id_stream
summary: Generate the current journey step interaction state
tags:
- journey
responses:
'200':
description: Server-sent journey interaction events
content:
text/event-stream:
schema:
type: string
'201':
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
required:
- intent
properties:
content:
type: string
intent:
type: string
enum:
- answer
- revise
- start_step
/api/journey/sessions/{session_id}/advance:
post:
operationId: post_journey_sessions_by_session_id_advance
summary: Advance an explicitly completed journey step
tags:
- journey
responses:
'200':
description: OK
'201':
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'409':
description: Stale or invalid journey state
'422':
description: Incomplete AI recommendation
security:
- cookieAuth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
required:
- action
- step
- state_version
properties:
action:
type: string
enum:
- continue
- use_ai_recommendation
step:
type: integer
state_version:
type: integer
minimum: 1
components:
securitySchemes:
cookieAuth:
type: apiKey
in: cookie
name: access_token_cookie
description: JWT access token stored in httpOnly cookie