---
title: "Create Scan"
method: POST
path: "/repos/{repo_id}/scan"
tags: ["Scans"]
---

# Create Scan

`POST /repos/{repo_id}/scan`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/repos/{repo_id}/scan`
- Auth: HTTP bearer

Record pre-computed repository scan results.

This endpoint does **not** scan a repository server-side — it persists a
scan produced by the `g8` CLI (or any MCP client that walks the filesystem
itself). Required fields in the body: ``tech_stack``, ``api_routes``,
``gtm_readiness``. The server stores the results and links them to the
repo so subsequent ``/install`` calls can derive a patch set.

## Path parameters

- `repo_id` string, required: Repository ID

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ScanResultsRequest
  - `tech_stack` object, required: Detected tech stack (framework, language, etc.)
  - `api_routes` object[]: Detected API routes
  - `readme_summary` string, nullable: Extracted README summary
  - `product_type` string, nullable: Detected product type (b2b_saas, api, etc.)
  - `gtm_readiness` object: GTM readiness flags
  - `scan_duration_ms` integer, nullable: Scan duration in milliseconds

## Response `201`

Successful Response

- ApiResponseScanResponse
  - `data` ScanResponse, required
    - `id` string, uuid, required
    - `repo_id` string, uuid, required
    - `tech_stack` object, required
    - `api_routes` object[], required
    - `readme_summary` string, nullable
    - `product_type` string, nullable
    - `gtm_readiness` object
    - `scan_duration_ms` integer, nullable
    - `created_at` string, date-time, nullable
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)