---
title: "Will this repository build"
method: GET
path: "/client/github/build-check"
tags: ["Apps"]
---

# Will this repository build

`GET /client/github/build-check`

## Request

- Base URL: `https://api.roar-ai.com`
- URL: `https://api.roar-ai.com/client/github/build-check`
- Auth: HTTP bearer

Query `repo`, optional `branch`, `rootDir` and `startCommand`. `{ data: { verdict, reason, fix, needsFolder, candidates, folders, foldersCapped, needsStart, offersStartCommand } }`. When `needsStart` is true, a `startCommand` is the fix; `offersStartCommand` is false for an app that starts itself (a repo Dockerfile, an image), where one is refused. `verdict` is `ok`, `blocked` (we read it and its first deploy would fail — creating the app is refused with the same reason) or `unread` (we could not read it; never a refusal). When `needsFolder` is true, pass one of `candidates` as `rootDir`. `data: null` when GitHub is not connected. Requires `apps:read`.

## Response `200`

The verdict

## Other responses

- `403`: Key lacks apps:read
- `404`: That repository was not found in your GitHub account

---

[API](https://skmtc.dev/roar-ai/apis/roar-ai-api.md) · [All operations](https://skmtc.dev/roar-ai/apis/roar-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/roar-ai/apis/roar-ai-api/revisions/37e4d0d5a7fe?raw)