Get Roadmap Result (JSON)

Use this endpoint to retrieve the structured AI analysis for a completed cognitive roadmap. The JSON response contains the full multi-instrument combined analysis, including overview text, domain scores, safety flags, and recommendations. The exact schema varies by roadmap product type.

Prerequisites

The roadmap must be finished with AI analysis (status: 1). If analysis is not yet complete, the endpoint returns a 409 error. Poll /roadmap/{token}/generate/status/ first to confirm completion.

Endpoint

GET https://braintest.ir/api/v2/roadmap/{token}/result/json/

Path Parameters

string

required

The unique cognitive roadmap instance UUID.

Response

object

Roadmap-specific structured AI output. The schema depends on the roadmap product type. Common fields include overview, domains, safety, and recommendations.

Example Request

curl -X GET "https://braintest.ir/api/v2/roadmap/b2c3d4e5-f6a7-8901-bcde-f12345678901/result/json/" \
  -H "API-KEY: YOUR_API_KEY"

Example Response

{
  "data": {
    "overview": {
      "title": "Clinical Wellbeing Overview",
      "summary": "Integrated analysis across submitted instruments."
    },
    "domains": [
      {
        "id": "mood",
        "score": 65,
        "label": "Moderate concern"
      }
    ],
    "safety": {
      "flags": []
    },
    "recommendations": {
      "short_term": [],
      "long_term": []
    }
  },
  "successful": true,
  "messages": []
}

Common Response Fields

Field	Description
`overview.title`	Report title
`overview.summary`	High-level narrative summary
`domains`	Array of scored domains with `id`, `score`, and `label`
`safety.flags`	Array of safety alerts if any are triggered
`recommendations.short_term`	Short-term action recommendations
`recommendations.long_term`	Long-term action recommendations

Error Responses

HTTP	Cause
404	Roadmap not found
409	Roadmap not yet finished with AI analysis

Overview

Connection

Records

Roadmaps

Get Roadmap Result (JSON)

Prerequisites

Endpoint

Path Parameters

Response

Example Request

Example Response

Common Response Fields

Error Responses

​Prerequisites

​Endpoint

​Path Parameters

​Response

​Example Request

​Example Response

​Common Response Fields

​Error Responses

Prerequisites

Endpoint

Path Parameters

Response

Example Request

Example Response

Common Response Fields

Error Responses