Skip to Content
Code Fundi for VS Code · Cursor: install the extension →

V2 Blueprint and scope

Product guide: Repo to Markdown.

Base URL: https://api.codefundi.app.


GET /v2/repos/{repo_id}/blueprint

Summary: Repository intelligence overview: README Markdown (documentation), README text (data), top dependencies, symbols, and conventions.

Credits: 1 credit / request. Prefer this over deprecated GET …/readme.

Query

ParameterDescription
conventions_path_prefixOptional path filter for conventions (PRO and above).

Response

FieldDescription
documentationMarkdown overview (LLM-ready).
dataREADME text content.
dependenciesTop dependency items.
symbolsTop functions / variables when available on your plan.
conventionsNaming/formatting profile on PRO and above when available.
blueprint.sh
curl -sS "https://api.codefundi.app/v2/repos/550e8400-e29b-41d4-a716-446655440000/blueprint" \ -H "X-API-Key: YOUR_API_KEY"

POST /v2/repos/{repo_id}/scope

Summary: Aggregated dependencies, functions, and variables for a repository.

Credits: 1 credit / request.

Request body

FieldDescription
includedependencies | functions | variables (default all available on your plan).
nameFilter / drill-down name.
typeDependency type when filtering.
expandfiles | functions (requires name).
compare_reposUp to 25 UUIDs (dependencies comparison).
limit / offset / orderPagination; order is usage | name.

Response: data.repo, data.summary, data.scope, optional per-kind pagination.

scope.sh
curl -sS -X POST "https://api.codefundi.app/v2/repos/550e8400-e29b-41d4-a716-446655440000/scope" \ -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_API_KEY" \ -d "{\"include\":[\"dependencies\",\"functions\"],\"limit\":50}"

For file-level Markdown, use V2 Files. For impact graphs, use Blast radius.

Last updated on