---
title: "Trigger an inspection against given repository connection."
method: POST
path: "/v1/repositories/{id}/inspect"
tags: ["Repository", "Repository-Lifecycle"]
---

# Trigger an inspection against given repository connection.

`POST /v1/repositories/{id}/inspect`

Inspect a repository connection by inspecting the specified version including repo's technical stack and developer environment requirements.

## Path parameters

- `id` string, required

## Request body

- RepositoryInspectParameters
  - `github_auth_token` string, nullable — GitHub authentication token for accessing private repositories.

## Response `200`

OK

- RepositoryInspectionDetails
  - `id` string, required — The ID of the inspection.
  - `commit_sha` string, required — The sha of the inspected version of the Repository.
  - `inspected_at` integer, required — Inspection time of the Repository Version (Unix timestamp milliseconds).
  - `repository_manifest` RepositoryManifestView, required — The repository manifest contains container configuration and workspace definitions for a repository.
    - `container_config` ContainerConfigView, required — Container configuration specifying the base image and setup commands.
      - `base_image_name` string, required — The name of the base image. Should be one of the GitHub public images like ubuntu-latest, ubuntu-24.04, ubuntu-22.04, windows-latest, windows-2022, macos-latest etc.
      - `setup_commands` string[], nullable — Commands to run to setup the base container such as installing necessary toolchains (e.g. apt install).
      - `architecture` 'x86_64' | 'arm64'
    - `workspaces` WorkspaceView[], required — List of workspaces within the repository. Each workspace represents a buildable unit of code.
      - `name` string, nullable — Name of the workspace. Can be empty if the workspace is the root of the repository. Only necessary for monorepo style repositories.
      - `path` string, nullable — Path to the workspace from the root of the repository. Can be empty if the workspace is the root of the repository. Only necessary for monorepo style repositories.
      - `build_tool` string[], required — Name of the build tool used (e.g. pip, npm).
      - `workspace_setup_commands` string[], nullable — Commands to run to setup this workspace after a fresh clone of the repository on a new container such as installing necessary toolchains and dependencies (e.g. npm install).
      - `workspace_refresh_commands` string[], nullable — Commands to run to refresh this workspace after pulling the latest changes to the repository via git (e.g. npm install).
      - `dev_commands` DevCommandsView — Commands available for this workspace.
        - `install` string[], nullable — Installation command (e.g. pip install -r requirements.txt).
        - `build` string[], nullable — Build command (e.g. npm run build).
        - `test` string[], nullable — Test command (e.g. pytest).
        - `lint` string[], nullable — Lint command (e.g. flake8).
        - `scripts` string[], nullable — Script commands.
    - `containerized_services` ContainerizedServiceView[], nullable — List of discovered ContainerizedServices. Services can be explicitly started when creating a Devbox.
      - `name` string, required — The name of the container service.
      - `image` string, required — The image of the container service.
      - `credentials` Credentials
        - `username` string, required — The username of the container service.
        - `password` string, required — The password of the container service.
      - `env` object, nullable — The environment variables of the container service.
      - `port_mappings` string[], nullable — The port mappings of the container service. Port mappings are in the format of <host_port>:<container_port>.
      - `options` string, nullable — Additional Docker container create options.
    - `languages` LanguageView[], required — List of required languages found in Repository.
      - `language` string
      - `version` string
    - `required_env_vars` string[], nullable — Missing environment variables that (may) be required for this repository to run correctly.
    - `env_vars` object, nullable — Qualified environment variables and values that should be set for this repository to run correctly.
  - `user_manifest` RepositoryManifestView — The repository manifest contains container configuration and workspace definitions for a repository.
    - `container_config` ContainerConfigView, required — Container configuration specifying the base image and setup commands.
      - `base_image_name` string, required — The name of the base image. Should be one of the GitHub public images like ubuntu-latest, ubuntu-24.04, ubuntu-22.04, windows-latest, windows-2022, macos-latest etc.
      - `setup_commands` string[], nullable — Commands to run to setup the base container such as installing necessary toolchains (e.g. apt install).
      - `architecture` 'x86_64' | 'arm64'
    - `workspaces` WorkspaceView[], required — List of workspaces within the repository. Each workspace represents a buildable unit of code.
      - `name` string, nullable — Name of the workspace. Can be empty if the workspace is the root of the repository. Only necessary for monorepo style repositories.
      - `path` string, nullable — Path to the workspace from the root of the repository. Can be empty if the workspace is the root of the repository. Only necessary for monorepo style repositories.
      - `build_tool` string[], required — Name of the build tool used (e.g. pip, npm).
      - `workspace_setup_commands` string[], nullable — Commands to run to setup this workspace after a fresh clone of the repository on a new container such as installing necessary toolchains and dependencies (e.g. npm install).
      - `workspace_refresh_commands` string[], nullable — Commands to run to refresh this workspace after pulling the latest changes to the repository via git (e.g. npm install).
      - `dev_commands` DevCommandsView — Commands available for this workspace.
        - `install` string[], nullable — Installation command (e.g. pip install -r requirements.txt).
        - `build` string[], nullable — Build command (e.g. npm run build).
        - `test` string[], nullable — Test command (e.g. pytest).
        - `lint` string[], nullable — Lint command (e.g. flake8).
        - `scripts` string[], nullable — Script commands.
    - `containerized_services` ContainerizedServiceView[], nullable — List of discovered ContainerizedServices. Services can be explicitly started when creating a Devbox.
      - `name` string, required — The name of the container service.
      - `image` string, required — The image of the container service.
      - `credentials` Credentials
        - `username` string, required — The username of the container service.
        - `password` string, required — The password of the container service.
      - `env` object, nullable — The environment variables of the container service.
      - `port_mappings` string[], nullable — The port mappings of the container service. Port mappings are in the format of <host_port>:<container_port>.
      - `options` string, nullable — Additional Docker container create options.
    - `languages` LanguageView[], required — List of required languages found in Repository.
      - `language` string
      - `version` string
    - `required_env_vars` string[], nullable — Missing environment variables that (may) be required for this repository to run correctly.
    - `env_vars` object, nullable — Qualified environment variables and values that should be set for this repository to run correctly.
  - `status` 'invalid' | 'repo_auth_pending' | 'repo_authentication_failure' | 'repo_access_failure' | 'inspection_pending' | 'inspection_failed' | 'inspection_success' | 'inspection_user_manifest_added', required
  - `build_status` 'image_building' | 'image_build_success' | 'image_build_failure'
  - `blueprint_id` string, nullable — The blueprint ID associated with this inspection if successful.
  - `blueprint_name` string, nullable — The blueprint name associated with this inspection if successful.
  - `workflow_contexts` object, nullable — Workflow contexts mapping workflow names to their processing details.

## Changes

- **2025-10-02** `6b65a42b7440` — 1 warning
  - removed the request property `blueprint_id`
- **2025-09-30** `9b2e136aedff` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/runloopai/apis/runloop-api/changes/v1/repositories/:id/inspect/post.md)

---

[API](https://skmtc.dev/runloopai/apis/runloop-api.md) · [All operations](https://skmtc.dev/runloopai/apis/runloop-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runloopai/runloop-api/revisions/32e4b2dfb757/schema)