Skip to main content
POST
/
api
/
v1
/
architecture
/
validate
Validate Architecture Payload
curl --request POST \
  --url https://api.example.com/api/v1/architecture/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "diagrams": [
    {}
  ],
  "entities": [
    {}
  ],
  "global_description": "<string>",
  "interfaces": [
    {}
  ],
  "title": "<string>"
}
'
{
  "issues": [
    "<string>"
  ],
  "suggested_fixes": [
    "<string>"
  ],
  "summary": {},
  "valid": true,
  "warnings": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Dry-run payload used to critique an Architecture Design without persisting it.

​
diagrams
Diagrams · object[] | null
​
entities
Entities · object[] | null
​
global_description
string | null
​
interfaces
Interfaces · object[] | null
​
title
string | null

Response

Successful Response

Semantic validation and authoring feedback for an Architecture Design payload.

​
issues
string[]
required
​
suggested_fixes
string[]
required
​
summary
Summary · object
required
​
valid
boolean
required
​
warnings
string[]
required
Last modified on May 17, 2026