Server API Reference

This file is automatically generated from the Kodit server OpenAPI specification. You can view the live API documentation on the /docs endpoint of your Kodit server or look at the hosted version.

Code understanding platform with hybrid search and LLM-powered enrichments Current version: 1.0.

Base URL

URL	Description
/api/v1

Authentication

Security Schemes

Name	Type	Description	Scheme	Bearer Format
APIKeyAuth	apiKey

APIs

GET /enrichments

List enrichments with optional filters

Parameters

Name	Type	Description
enrichment_type	string	Filter by enrichment type
enrichment_subtype	string	Filter by enrichment subtype
page	integer	Page number (default: 1)
page_size	integer	Results per page (default: 20, max: 100)

Responses

200: OK

dto.EnrichmentJSONAPIListResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

DELETE /enrichments/{id}

Delete an enrichment by ID

Parameters

Name	Type	Required	Description
id	integer	True	Enrichment ID

Responses

204: No Content
404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /enrichments/{id}

Get an enrichment by ID

Parameters

Name	Type	Required	Description
id	integer	True	Enrichment ID

Responses

200: OK

dto.EnrichmentJSONAPIResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

PATCH /enrichments/{id}

Update an enrichment’s content

Parameters

Name	Type	Required	Description
id	integer	True	Enrichment ID

Request Body

dto.EnrichmentUpdateRequest

Responses

200: OK

dto.EnrichmentJSONAPIResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /queue

List tasks in the queue

Parameters

Name	Type	Description
page	integer	Page number (default: 1)
page_size	integer	Results per page (default: 20, max: 100)
task_type	string	Filter by task type

Responses

200: OK

dto.TaskListResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /queue/{task_id}

Get a task by ID

Parameters

Name	Type	Required	Description
task_id	integer	True	Task ID

Responses

200: OK

dto.TaskResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories

Get all tracked Git repositories

Parameters

Name	Type	Required	Description
page	integer		Page number (default: 1)
page_size	integer		Results per page (default: 20, max: 100)

Responses

200: OK

dto.RepositoryListResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

POST /repositories

Add a new Git repository to track

Request Body

dto.RepositoryCreateRequest

Responses

200: Repository already exists

dto.RepositoryResponse

201: Repository created

dto.RepositoryResponse

400: Bad Request

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

DELETE /repositories/{id}

Delete a repository by ID

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID

Responses

204: No Content
404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}

Get a repository by ID

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID

Responses

200: OK

dto.RepositoryDetailsResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/blob/{blob_name}/{path}

Returns raw file content from a Git repository at a given blob reference (commit SHA, tag, or branch)

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
blob_name	string	True	Commit SHA, tag name, or branch name
path	string	True	File path within the repository
lines	string		Line ranges to extract (e.g. L17-L26,L45,L55-L90)
line_numbers	boolean		Prefix each line with its 1-based line number

Responses

200: OK
400: Bad Request

middleware.JSONAPIErrorResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/commits

List commits for a repository

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
page	integer		Page number (default: 1)
page_size	integer		Results per page (default: 20, max: 100)

Responses

200: OK

dto.CommitJSONAPIListResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/commits/{commit_sha}

Get a commit by SHA

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
commit_sha	string	True	Commit SHA

Responses

200: OK

dto.CommitJSONAPIResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/commits/{commit_sha}/embeddings

This endpoint has been removed. Embeddings are an internal detail of snippets and enrichments.

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
commit_sha	string	True	Commit SHA

Responses

410: Gone

middleware.JSONAPIErrorResponse

DELETE /repositories/{id}/commits/{commit_sha}/enrichments

Delete all enrichments for a commit

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
commit_sha	string	True	Commit SHA

Responses

204: No Content
404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/commits/{commit_sha}/enrichments

List enrichments for a commit

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
commit_sha	string	True	Commit SHA
enrichment_type	string		Filter by enrichment type
enrichment_subtype	string		Filter by enrichment subtype
page	integer		Page number (default: 1)
page_size	integer		Results per page (default: 20, max: 100)

Responses

200: OK

dto.EnrichmentJSONAPIListResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

DELETE /repositories/{id}/commits/{commit_sha}/enrichments/{enrichment_id}

Delete a specific enrichment from a commit

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
commit_sha	string	True	Commit SHA
enrichment_id	integer	True	Enrichment ID

Responses

204: No Content
404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/commits/{commit_sha}/enrichments/{enrichment_id}

Get an enrichment by ID within commit context

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
commit_sha	string	True	Commit SHA
enrichment_id	integer	True	Enrichment ID

Responses

200: OK

dto.EnrichmentJSONAPIResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/commits/{commit_sha}/files

List files for a commit

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
commit_sha	string	True	Commit SHA
page	integer		Page number (default: 1)
page_size	integer		Results per page (default: 20, max: 100)

Responses

200: OK

dto.FileJSONAPIListResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/commits/{commit_sha}/files/{blob_sha}

Get a file by blob SHA

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
commit_sha	string	True	Commit SHA
blob_sha	string	True	Blob SHA

Responses

200: OK

dto.FileJSONAPIResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

POST /repositories/{id}/commits/{commit_sha}/rescan

Trigger a rescan of a specific commit

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
commit_sha	string	True	Commit SHA

Responses

202: Accepted
404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/commits/{commit_sha}/snippets

List code snippets for a commit (backed by enrichments)

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
commit_sha	string	True	Commit SHA
page	integer		Page number (default: 1)
page_size	integer		Results per page (default: 20, max: 100)

Responses

200: OK

dto.SnippetListResponse

401: Unauthorized

middleware.JSONAPIErrorResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/enrichments

List recent enrichments across commits for a repository

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
enrichment_type	string		Filter by enrichment type
max_commits_to_check	integer		Max commits to check (default: 100)
page	integer		Page number (default: 1)
page_size	integer		Results per page (default: 20, max: 100)

Responses

200: OK

dto.EnrichmentJSONAPIListResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/status

Get indexing task status for a repository

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID

Responses

200: OK

dto.TaskStatusListResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/status/summary

Get aggregated indexing status summary for a repository

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID

Responses

200: OK

dto.RepositoryStatusSummaryResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

POST /repositories/{id}/sync

Trigger a sync (git fetch + branch scan + commit indexing) for a repository

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID

Responses

202: Accepted
404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/tags

List tags for a repository

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
page	integer		Page number (default: 1)
page_size	integer		Results per page (default: 20, max: 100)

Responses

200: OK

dto.TagJSONAPIListResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/tags/{tag_name}

Get a tag by name

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
tag_name	string	True	Tag name

Responses

200: OK

dto.TagJSONAPIResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/tracking-config

Get current tracking configuration for a repository

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID

Responses

200: OK

dto.TrackingConfigResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

PUT /repositories/{id}/tracking-config

Update tracking configuration for a repository

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID

Request Body

dto.TrackingConfigUpdateRequest

Responses

200: OK

dto.TrackingConfigResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/wiki

Get the wiki navigation tree (titles and paths, no content)

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID

Responses

200: OK

dto.WikiTreeResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

POST /repositories/{id}/wiki/rescan

Delete the existing wiki and regenerate it from scratch

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID

Responses

202: Accepted
404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /repositories/{id}/wiki/{path}

Get a wiki page by hierarchical path as raw markdown

Parameters

Name	Type	Required	Description
id	integer	True	Repository ID
path	string	True	Wiki page path (e.g. architecture/database-layer.md)

Responses

200: OK

string

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

POST /search

Hybrid search across code snippets and enrichments

Request Body

dto.SearchRequest

Responses

200: OK

dto.SearchResponse

400: Bad Request

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /search/grep

Search file contents in a repository using git grep with regex patterns

Parameters

Name	Type	Required	Description
repository_id	integer	True	Repository ID
pattern	string	True	Regex pattern to search for
glob	string		File path filter (e.g. .go, src//.ts)
limit	integer		Maximum number of file results (default 10, max 200)

Responses

200: OK

dto.GrepResponse

400: Bad Request

middleware.JSONAPIErrorResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /search/keyword

Search code snippets using BM25 keyword matching

Parameters

Name	Type	Required	Description
keywords	string	True	Search keywords
language	string		Language filter (e.g. py, go)
repository_id	integer		Repository ID filter
limit	integer		Maximum results (default 10)

Responses

200: OK

dto.SearchResponse

400: Bad Request

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /search/ls

Returns files from a repository working copy matching a glob pattern, with file:// URIs

Parameters

Name	Type	Required	Description
repository_id	integer	True	Repository ID
pattern	string	True	Glob/pathspec pattern (e.g. */.go, src/*.py)
page	integer		Page number (default: 1)
page_size	integer		Results per page (default: 20, max: 100)

Responses

200: OK

dto.LsResponse

400: Bad Request

middleware.JSONAPIErrorResponse

404: Not Found

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

GET /search/semantic

Search code snippets using semantic similarity

Parameters

Name	Type	Required	Description
query	string	True	Natural language search query
language	string		Language filter (e.g. py, go)
repository_id	integer		Repository ID filter
limit	integer		Maximum results (default 10)

Responses

200: OK

dto.SearchResponse

400: Bad Request

middleware.JSONAPIErrorResponse

500: Internal Server Error

middleware.JSONAPIErrorResponse

Components

dto.CommitAttributes

Field	Type	Description
author	string
commit_sha	string
date	string
message	string
parent_commit_sha	string

dto.CommitData

Field	Type	Description
attributes
id	string
type	string

dto.CommitJSONAPIListResponse

Field	Type	Description
data	array
links
meta

dto.CommitJSONAPIResponse

Field	Type	Description
data

dto.EnrichmentAttributes

Field	Type	Description
content	string
created_at	string
end_line	integer
start_line	integer
subtype	string
type	string
updated_at	string

dto.EnrichmentData

Field	Type	Description
attributes
id	string
type	string

dto.EnrichmentJSONAPIListResponse

Field	Type	Description
data	array
links
meta

dto.EnrichmentJSONAPIResponse

Field	Type	Description
data

dto.EnrichmentSchema

Field	Type	Description
content	string
type	string

dto.EnrichmentUpdateAttributes

Field	Type	Description
content	string

dto.EnrichmentUpdateData

Field	Type	Description
attributes
type	string

dto.EnrichmentUpdateRequest

Field	Type	Description
data

dto.FileAttributes

Field	Type	Description
blob_sha	string
extension	string
mime_type	string
path	string
size	integer

dto.FileData

Field	Type	Description
attributes
id	string
type	string

dto.FileJSONAPIListResponse

Field	Type	Description
data	array
links
meta

dto.FileJSONAPIResponse

Field	Type	Description
data

dto.GrepFileLinks

Field	Type	Description
file	string

dto.GrepFileSchema

Field	Type	Description
language	string
links
matches	array
path	string

dto.GrepMatchSchema

Field	Type	Description
content	string
line	integer

dto.GrepResponse

Field	Type	Description
data	array

dto.LsFileAttributes

Field	Type	Description
path	string
size	integer

dto.LsFileData

Field	Type	Description
attributes
id	string
links
type	string

dto.LsFileLinks

Field	Type	Description
self	string

dto.LsResponse

Field	Type	Description
data	array
links
meta

dto.RepositoryAttributes

Field	Type	Description
cloned_path	string
created_at	string
last_scanned_at	string
num_branches	integer
num_commits	integer
num_tags	integer
remote_uri	string
tracking_branch	string
updated_at	string

dto.RepositoryBranchData

Field	Type	Description
commit_count	integer
is_default	boolean
name	string

dto.RepositoryCommitData

Field	Type	Description
author	string
message	string
sha	string
timestamp	string

dto.RepositoryCreateAttributes

Field	Type	Description
remote_uri	string

dto.RepositoryCreateData

Field	Type	Description
attributes
type	string

dto.RepositoryCreateRequest

Field	Type	Description
data

dto.RepositoryData

Field	Type	Description
attributes
id	string
type	string

dto.RepositoryDetailsResponse

Field	Type	Description
branches	array
data
recent_commits	array

dto.RepositoryListResponse

Field	Type	Description
data	array
links
meta

dto.RepositoryResponse

Field	Type	Description
data

dto.RepositoryStatusSummaryAttributes

Field	Type	Description
message	string
status	string
updated_at	string

dto.RepositoryStatusSummaryData

Field	Type	Description
attributes
id	string
type	string

dto.RepositoryStatusSummaryResponse

Field	Type	Description
data

dto.SearchAttributes

Field	Type	Description
code	string
filters
keywords	array
limit	integer
text	string

dto.SearchData

Field	Type	Description
attributes
type	string

dto.SearchFilters

Field	Type	Description
authors	array
commit_sha	array
end_date	string
enrichment_subtypes	array
enrichment_types	array
file_patterns	array
languages	array
sources	array
start_date	string

dto.SearchRequest

Field	Type	Description
data

dto.SearchResponse

Field	Type	Description
data	array

dto.SnippetAttributes

Field	Type	Description
content
created_at	string
enrichments	array
original_scores	array
updated_at	string

dto.SnippetContentSchema

Field	Type	Description
end_line	integer
language	string
start_line	integer
value	string

dto.SnippetData

Field	Type	Description
attributes
id	string
links
type	string

dto.SnippetLinks

Field	Type	Description
commit	string
file	string
repository	string

dto.SnippetListResponse

Field	Type	Description
data	array
links
meta

dto.TagAttributes

Field	Type	Description
is_version_tag	boolean
name	string
target_commit_sha	string

dto.TagData

Field	Type	Description
attributes
id	string
type	string

dto.TagJSONAPIListResponse

Field	Type	Description
data	array
links
meta

dto.TagJSONAPIResponse

Field	Type	Description
data

dto.TaskAttributes

Field	Type	Description
created_at	string
payload
priority	integer
type	string
updated_at	string

dto.TaskData

Field	Type	Description
attributes
id	string
type	string

dto.TaskListResponse

Field	Type	Description
data	array
links
meta

dto.TaskResponse

Field	Type	Description
data

dto.TaskStatusAttributes

Field	Type	Description
created_at	string
current	integer
error	string
message	string
progress	number
state	string
step	string
total	integer
updated_at	string

dto.TaskStatusData

Field	Type	Description
attributes
id	string
type	string

dto.TaskStatusListResponse

Field	Type	Description
data	array
links
meta

dto.TrackingConfigAttributes

Field	Type	Description
mode
value	string

dto.TrackingConfigData

Field	Type	Description
attributes
type	string

dto.TrackingConfigResponse

Field	Type	Description
data

dto.TrackingConfigUpdateAttributes

Field	Type	Description
mode
value	string

dto.TrackingConfigUpdateData

Field	Type	Description
attributes
type	string

dto.TrackingConfigUpdateRequest

Field	Type	Description
data

dto.TrackingMode

dto.WikiTreeNode

Field	Type	Description
children	array
path	string
slug	string
title	string

dto.WikiTreeResponse

Field	Type	Description
data	array

jsonapi.Links

Field	Type	Description
first	string
last	string
next	string
prev	string
self	string

jsonapi.Meta

middleware.JSONAPIError

Field	Type	Description
detail	string
id	string
status	string
title	string

middleware.JSONAPIErrorResponse

Field	Type	Description
errors	array

Configuration Reference Go SDK Reference