Upload a roadmap file (or paste text) and start the comparison pipeline
const url = 'https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/roadmap-check';const form = new FormData();form.append('file', 'file');form.append('discussion', 'example');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/roadmap-check \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: multipart/form-data' \ --form file=@file \ --form discussion=exampleAuthorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Project UUID
Request Body required
Section titled “Request Body required ”object
Roadmap file (.docx, .pdf, .txt, .md, .png, .jpg, .jpeg, .webp, .gif — max 10MB)
Optional assistant chat transcript to include as extra requirements context.
object
Pasted requirements text. Stored as a synthetic markdown blob. Max 10MB UTF-8.
Optional assistant chat transcript to include as extra requirements context.
Responses
Section titled “ Responses ”Roadmap check started
object
Invalid file type, size, or empty pasted text
Not authenticated
object
Human-readable error message
Stable machine-readable error code for client branching
First validation message per field path
object
Structured validation issues (Zod)
object
Seconds until rate limit resets (429 responses)
True if re-linking GitHub may fix the issue
Forbidden
object
Human-readable error message
Stable machine-readable error code for client branching
First validation message per field path
object
Structured validation issues (Zod)
object
Seconds until rate limit resets (429 responses)