List requirement suggestions and AI analysis for a check

GET

/projects/{id}/roadmap-check/{checkId}/suggestions

const url = 'https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/roadmap-check/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/suggestions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/roadmap-check/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/suggestions \
  --header 'Authorization: Bearer <token>'

Returns one row per extracted requirement with the AI’s recommended action, evidence, and confidence. Also includes the analysis block describing what the AI saw — extracted stories, GitHub repos + file paths inspected, model

scope. Used by the Decide step of the requirement intake wizard.

Authorizations

bearerApiKey

Parameters

Path Parameters

required

string format: uuid

Project UUID

checkId

required

string format: uuid

Responses

200

Suggestions, summary counts, and analysis metadata

application/json

object

suggestions

required

Array<object>

object

string format: uuid

requirement_title

string

requirement_description

string | null

current_status

string

Allowed values: shipped partial missing duplicate unclear

suggested_action

string

Allowed values: create_ticket update_ticket skip merge_duplicate move_milestone suggest_new_milestone

suggested_milestone_id

string | null format: uuid

suggested_milestone_title

string | null

existing_ticket_id

string | null format: uuid

evidence

Array<object>

object

type

string

Allowed values: code_path ticket milestone

ref

string

note

string | null

reasoning

string | null

confidence

string

Allowed values: high medium low

approval_status

string

Allowed values: pending approved rejected edited applied failed

edited_payload

object | null

apply_result

object | null

created_at

string format: date-time

updated_at

string format: date-time

summary

required

object

pending

integer

approved

integer

rejected

integer

edited

integer

applied

integer

failed

integer

total

integer

analysis

required

object

status

string

Allowed values: uploading extracting fetching_code comparing suggesting complete failed

error_message

string | null

source_filename

string | null

stories

Array<object>

object

string

title

string

description

string

code_context

Snapshot of GitHub repos/paths/files the AI inspected. Shape: { files_inspected_count, tree_paths_count, repos: [{ slug, sha, default_branch, tree_paths_count, files_inspected: [path,…] }] }.

object | null

analysis_meta

Model + scope metadata. Shape: { model, batches_run, ticket_context_count, milestone_context_count }.

object | null

401

Not authenticated

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

reconnect

True if re-linking GitHub may fix the issue

boolean

403

Forbidden

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

404

Roadmap check not found