Sign in
repos

Index Repo

post/repos/index

Request body

urlstring required

GitHub repo URL or owner/name shorthand

refstring nullable

Branch ref to index (defaults to repo's default branch)

commit_depth'2000' | 'full'
commit_limitinteger nullable

Numeric commit limit (overrides commit_depth)

skip_testsboolean
skip_infraboolean
follow_renamesboolean
include_submodulesboolean
exclude_patternsstring[]
generate_docsboolean
docs_file_percentagenumber
wiki_style'comprehensive' | 'caveman' | 'reference' | 'tutorial'
docs_language'en' | 'ru' | 'es' | 'fr' | 'de' | 'zh' | 'ja' | 'ko' | 'it' | 'pt' | 'nl' | 'pl' | 'tr' | 'ar' | 'hi'
prose_cap_cents100 | 200 | 500 | 1000 nullable

Cents pre-authorized for AI explanations (omit to opt out)

Response

Successful Response

snapshot_idstring required
short_idstring required
status'queued' | 'indexing' | 'ready' | 'failed' required
cachedboolean required

Changes

No recorded changes to this endpoint across all 1 revision of this API.