v1

latestOpenAPI 3.1.02026-08-066132.7 KB

Instant repo overview — languages, complexity, file count, tech stack, code quality findings, and credential scanning. Use as your first call to understand any remote public codebase. Supports language filtering and path scoping (for large monorepos, analyze a subdirectory instead of the full repo). When analysing multiple repositories, call in parallel rather than sequentially. Dependency/build directories excluded by default.

post/api/v1/code_analyze

Query parameters

clientstring required

Client identifier for your application (e.g. 'my-app-v1'). Required for all REST API requests.

Request body

detail_level'summary' | 'full'

Controls response verbosity. summary returns top 20 across all languages; full returns top 20 per language. Use summary for portfolio reviews, hiring assessments, and high-level overviews. Use full for deep per-language audits or when you need granular per-file breakdowns within a specific language.

include_all_dirsboolean

Include dependency/build/cache directories that are excluded by default (vendor, node_modules, third_party, target, build, dist, Pods, generated, etc.). Set to true if you need to analyze generated/vendored code.

languagestring

Filter results to a specific language (e.g. "Java", "Go", "Python").

pathstring

Subdirectory to scope analysis to (e.g. 'src', 'clang/lib'). Only files under this path are walked and analyzed — use this for large monorepos where full analysis is too slow or when the user's question is about a specific component. Omit to analyze the entire repository.

repositorystring required

Git URL of a public remote repository

scan_test_filesboolean

Include test files in code quality and credential scan results. Test files are excluded by default to reduce false positives (e.g. test credit card numbers, mock credentials). Set to true if you need to audit test code.

Response

Successful response

object required
All 6 operations